The digital tool for projects in the field: Web-based application to manage documents, images, videos and geodata.
Branch: master
Clone or download
Latest commit 55bb9eb Feb 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Corrected typo in issue template (#209) Feb 19, 2019
.gitlab/merge_request_templates Add GitHub pull request template and uniform gitlab and Github pull/m… Jun 21, 2018
app Fix create collection error when name equal to trashed one (#198) Dec 24, 2018
bin Video processing integration Oct 3, 2017
bootstrap Upgrade to Laravel 5.5 (#115) Jul 22, 2018
config Rename "personal" to "my uploads" (#193) Dec 4, 2018
database Fix create collection error when name equal to trashed one (#198) Dec 24, 2018
deploy-screens Prepare version 0.16.0 Aug 17, 2017
docker Improve automatic php max upload and post size calculation (#200) Jan 10, 2019
docs prepare release 0.25.3 Feb 19, 2019
packages Update translation Feb 18, 2019
plugins prepare release 0.25.3 Feb 19, 2019
public Update Help pages (#148) Oct 15, 2018
resources Update translation Feb 18, 2019
routes Rename "personal" to "my uploads" (#193) Dec 4, 2018
storage Squashed v0.4.18. Dec 2, 2015
tests
workbench/klink Create project capability (#192) Dec 4, 2018
.dockerignore Enable Docker Hub autobuild and publish (#107) Jul 5, 2018
.gitattributes Integration of the tus based upload, move to php 7 and nginx Aug 28, 2017
.gitignore document elaboration pipeline Sep 25, 2017
.gitlab-ci.yml Test try deploy using tagged image Nov 26, 2018
.php_cs Prepare version 0.18.0-RC1 Aug 17, 2017
.travis.yml Geo location indexing support (#136) Sep 28, 2018
Dockerfile Update Nginx installation and fix gpg key errors (#177) Nov 15, 2018
LICENSE.txt Added GNU aGPL3 license Aug 17, 2017
artisan Squashed v0.4.18. Dec 2, 2015
changelog.md prepare release 0.25.3 Feb 19, 2019
composer.json GDPR handle privacy policy and consent (#176) Nov 26, 2018
composer.lock GDPR handle privacy policy and consent (#176) Nov 26, 2018
contributing.md Revised the contribution guide Jan 31, 2018
docker-compose.dev.example.yml Avoid populating Authors and Uploader with personal data (#166) Nov 1, 2018
docker-compose.example.yml Bump to 0.25.2 Feb 18, 2019
env.ci Automatic generation of the application key (#72) May 2, 2018
env.example Improve configuration variables name and documentation (#83) Jun 21, 2018
env.travis Geo location indexing support (#136) Sep 28, 2018
gulpfile.js Disable tiling on GeoTiff preview when bands type is not Byte (#153) Oct 17, 2018
package.json prepare release 0.25.3 Feb 19, 2019
phpunit.xml File type detection and thumbnails extension (#130) Sep 4, 2018
readme.md prepare release 0.25.3 Feb 19, 2019
server.php
yarn.lock Disable tiling on GeoTiff preview when bands type is not Byte (#153) Oct 17, 2018

readme.md

Build Status latest version

K-Box

The digital tool for projects in the field: Web-based application to manage documents, images, videos and geodata. It contains a full content search, a translated interface into several languages and it connects easily to the K-Link services.

K-Box Logo

Visit the K-Link.technology website for more information!

If you find any issues with this application, please report them at the issue tracker. Contributions are both encouraged and appreciated. If you would like to contribute, please check the website for more information.

The upstream repository is at: https://github.com/k-box/k-box

Installation

K-Box can be installed on most operating systems. The setup is heavily based on Docker.

Prerequisites

Simplest installation

These few commands allow you to quickly install a K-Box locally on your computer for testing purposes.

  • Create a directory: mkdir k-box && cd k-box
  • Download configuration file: curl -o docker-compose.yml https://raw.githubusercontent.com/k-box/k-box/master/docker-compose.example.yml
  • Start up services: docker-compose up -d (when running this for the first time, it will download a lot of data and take a while)
  • Create the administrator: docker-compose exec kbox php artisan create-admin admin@kbox.local
  • Visit your K-Box: http://localhost:8080 (you can login to the K-Box with the username admin@kbox.local and the chosen password).

For installation on a server in the Internet or more configuration options, see the documentation on installation of the K-Box.

Components

The K-Box consists of different components:

Name Image Based on Description
K-Box application kbox PHP and Laravel 5 The interface of the knowledge management system
K-Search API ksearch PHP and Symfony 4 Full text search component used for K-Link and K-Box
K-Search Engine engine Apache SOLR Open Source search engine pre-configured for the K-Search
Database database MariaDB A database for the use of the K-Box web application.

Development

Programmers may check out the developers documentation

Testing

The K-Box code is covered by unit tests. For more information see Executing Unit Tests.

License

GNU AGPLv3 Image

This program is Free Software: You can use, study, share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.

Your contribution is very welcome. Find more information in our contribution guide.