k-box / k-link

Connects various information sources to a common digital library and provides search, retrieval and exchange of information from different platforms.

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

• Check the system requirements.
• Use an operating system supported by Docker (ideally GNU/Linux; we use Debian)
• Make sure you have installed the latest version of Docker and Docker Compose.

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 [email protected] or sudo docker-compose exec kbox php artisan create-admin [email protected], depending on your configuration of Docker
• Visit your K-Box: http://localhost:8080 (you can login to the K-Box with the username [email protected] 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.

k-link's Issues

[Enhancement] Enhance the results from a K-Link search with open data / information

Short Description of the issue

When performing a public search, the results could also include relevant external data sources (Wikipedia, OpenStreetMap, GeoNames, https://data.worldbank.org/, wikicommons, https://archive.org, https://datacatalog.worldbank.org/, http://databank.worldbank.org/data/home.aspx, http://microdata.worldbank.org/index.php/home, http://projects.worldbank.org/, etc.).

The trick would be to find a good visualisation of the results, in order to not overload the list of results. Maybe the search results can be split into 2 tabs:

Results from [K-Box or K-Link]	Results from other sources
All documents from	(if applicable) slippy map showing the location of the place in my search
my k_box or my K-Link network	(if applicable) snippet of the relevant Wikipedia page(s) with language switcher
(this is the current behavior)	(if applicable) relevant statistics from the World Bank data portal
etc	etc

If this is developed in a generic way (i.e., easily possible to add other data sources and visualisation of results in the future), that could upgrade the K-Link API into an aggregator of open data sources

See here the World Bank API: https://datahelpdesk.worldbank.org/knowledgebase/articles/889386

Expected behavior

Explained above

Steps to reproduce the incorrect behavior

N/A

General information

N/A

Screenshots

N/A

Support multiple instances on one K-Link

In order to improve efficiency for deployment, hosting and maintenance the K-Link shall be extended to support multiple K-Link instances on one K-Link installation.

Therefore the following tasks are defined:

• Extend the API to an K-Link identifier
• Extend the K-Search Library to search for a predefined K-Link identifier

Update official docker image url

In the past Docker images have been hosted on docker.klink.asia and partially under the oneofftech DockerHub user. This lead to some confusion and problems in keeping up-to-date the documentation.

In an effort to better organize the distribution of the project we are going to use a single organization to store the Docker images: klinktech.

In particular the K-Link will be available under klinktech/k-link.

Serve, via API, the name of the K-Link to show

The name of the K-Link is configured in the service and therefore is not correct that on every integration the same name needs to be written to show it to users.

The name of the K-Link should be obtained by the integration in an automatic way.

This is connected to the changes for #7