README.md

Fab-Manager's documentations

Table of contents

1. User's manual
   
2. System administrator
   2.1. Upgrades procedures
   
3. Translator's documentation
   
4. Developer's documentation
   4.1. Architecture
   4.2. How to setup a development environment
   4.3. Externals
   4.4. Diagrams
   

User's manual

The following guide describes what you can do and how to use Fab-manager.

• Français

System administrator

The following guides are designed for the people that perform software maintenance.

• Setup and update a production environment

• Installing behind a corporate proxy

• Configuring the environment variables

• Known issues with Fab-Manager

• Advanced PostgreSQL usage

• Connecting an SSO using oAuth 2.0

• Connecting an SSO using OpenID Connect

• Upgrade from Fab-manager v1.0

• Configuring OpenProjects

Upgrades procedures

• PostgreSQL
• ElasticSearch

Translator's documentation

If you intend to translate Fab-manager to a new, or an already supported language, you'll find here the information you need.

• Guide for translators

Developer's documentation

The following guides should help those who want to contribute to the code.

Architecture

• Code architecture

• Plugins

• How the data model works for Availabilities and Reservations

How to setup a development environment

• With docker-compose

• With vagrant

Externals

• ElasticSearch mapping

• Changing the database system

Diagrams

• Database diagram

• Class diagram

• Javascript dependencies

• Ruby dependencies