inventaire/docs
2025-06-06 10:35:56 +02:00
..
administration docs: update links to match forgejo path structure 2025-05-17 12:17:24 +02:00
configuration de-github-ify links 2025-05-16 16:54:53 +02:00
development docs: + development/running_tests.md 2025-06-06 10:35:56 +02:00
entities_host_specific docs: update links to match forgejo path structure 2025-05-17 12:17:24 +02:00
installation de-github-ify links 2025-05-16 16:54:53 +02:00
README.md docs: + development/running_tests.md 2025-06-06 10:35:56 +02:00

Documentation

This directory hosts the main technical documentation about Inventaire, including how to set up a development or a production environment.

Installation

What you need to install will depend on if you are trying to set up a development or a production environment:

  • In development, you will need the server and client repositories of course, and their dependencies: CouchDB, Elasticsearch, GraphicsMagick
  • In production, in addition to those dependencies, you will need a reverse proxy, typically Nginx, to handle TLS termination, image resizing and caching, etc

For details on how to install all of those:

Configuration

See the configuration directory.

Administration

See the administration directory.

Entities host instance specifics

See the entities_host_specific directory.

Development

See the development directory.