Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
app
 
 
bin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build Status latest release License AGPL-3.0

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.

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 or sudo docker-compose up -d, depending on your configuration of Docker (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 or sudo docker-compose exec kbox php artisan create-admin admin@kbox.local, depending on your configuration of Docker
  • 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 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.

Contributing

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

License

The K-Box is licensed under the GNU Affero General Public License v3.0.

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 AGPL 3.0 license.