inventaire/docker-inventaire
2
0
Fork 0
Code Issues 3 Pull requests Activity
A containerized, production-ready Inventaire system that allows you to self-host a knowledge graph similar to inventaire.io.
145 commits 8 branches 0 tags 240 KiB
Find a file
maxlath 513ec266d3 inventaire: docker-entrypoint: fix leveldb directory path 
The actual leveldb directory was /opt/inventaire_leveldb-prod instead of /opt/inventaire_leveldb

Made possible by the `suffixDirectoryPathWithDbSuffix` config parameter introduced by 7447c00

Addressing #14
2025-06-03 16:07:16 +02:00
.github add .github/README 2025-05-16 17:13:27 +02:00
couchdb couchdb config: increase session timeout 2025-03-04 13:22:34 +01:00
inventaire inventaire: docker-entrypoint: fix leveldb directory path 2025-06-03 16:07:16 +02:00
nginx nginx: fix inconsistencies in certbox public file directory 2025-05-31 16:50:14 +02:00
scripts scripts: docker_publish: set version tag and push tags 2025-06-03 15:29:35 +02:00
.gitignore gitignore: add certbot folder 2025-02-28 11:42:48 +01:00
docker-compose.yml nginx: fix inconsistencies in certbox public file directory 2025-05-31 16:50:14 +02:00
dotenv inventaire: add map tiles, analytics, and media storage configuration 2025-02-28 11:42:48 +01:00
README.md update links after codeberg migration 2025-05-17 12:22:33 +02:00

README.md

Inventaire Suite

The Inventaire Suite is a containerized, production-ready Inventaire system that allows you to self-host a knowledge graph similar to inventaire.io.

It is composed of several services:

  • Inventaire: a Docker image packaging:
    • the Inventaire server, which comes with its embedded database: LevelDB
    • the Inventaire client
  • CouchDB: the primary database used by the Inventaire server
  • Elasticsearch: a secondary database used by Inventaire for text and geographic search features
  • Nginx: a reverse proxy with TLS termination thank to Let's Encrypt certbot.

The service orchestration is implemented using Docker Compose.

🔧 This document is for people wanting to self-host the full Inventaire Suite. If you are looking for the individual Inventaire image, head over to hub.docker.com/r/inventaire/inventaire.

💡 This document presumes familiarity with basic Linux administration tasks and with Docker and Docker Compose.

Summary

Quickstart

Requirements

Hardware

  • Network connection with a public IP address
  • 4 GB RAM
  • 10 GB free disk space

Software

Domain name

Ignore this section if you are just testing on your local machine

You need a DNS records that resolves to your machine's public IP address

Open ports

Ignore this section if you are just testing on your local machine

Your machine's firewall should let the http ports (80 and 443) open.

Initial setup

Download this repository

git clone https://git.inventaire.io/docker-inventaire.git
cd docker-inventaire

Initial configuration

Copy the dotenv file to .env

cp dotenv .env

and open this new .env file with a text editor to customize the variables (mainly adding your own domain name, and setup a couchdb password)

Generate a TLS certificate

Ignore this section if you are just testing on your local machine

Generate the first TLS certificate with Let's Encrypt

docker run -it --rm --name certbot -p 80:80 -v "$(pwd)/certbot/conf:/etc/letsencrypt" certbot/certbot certonly --standalone

Usage

Start all the services (Nginx, CouchDB, Elasticsearch, and the Inventaire server) in production mode:

docker compose up --detach

Alternatively, to test locally, you can start only Inventaire and its dependencies (CouchDB and Elasticsearch) without Nginx, with the following command:

docker compose up inventaire

Update

Before updating to the latest version, check that there are no breaking changes. You can find your current version number by visiting fetching the URL /api/config on your domain (example: https://inventaire.io/api/config). You can find details about the changes since your version on this page: /home/maxlath/code/inventaire/inventaire/CHANGELOG.md. For changes marked to require data transformation, some knowledge of CouchDB is recommended, as well as familiarizing yourself with the recommanded way to export, transform and reimport data in CouchDB.

cd docker-inventaire
# Pull updates to this repository (might include database versions updates, and such)
git pull origin main
# Pull the updated images
docker compose pull
# Stop and remove the previous containers
docker compose down
# Remove the volume hosting inventaire server and client code, to let it be overriden by the updated inventaire image
docker volume rm docker-inventaire_inventaire-server
# Restart containers with the new image (with the --detach option, to be able to close the terminal)
docker compose up --detach
# Check that it restarted without errors
docker compose logs --follow --tail 500 inventaire

Tips

General tips on how to run Inventaire can be found in the server repository docs.

Troubleshooting

Elasticsearch errors

  • max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]: fix by running the command sudo sysctl -w vm.max_map_count=262144 on your host machine

See also Elasticsearch with Docker