2020-04-08 17:03:29 +02:00
|
|
|
# Fab-Manager's documentations
|
|
|
|
|
|
2021-06-14 13:49:38 +02:00
|
|
|
##### Table of contents
|
|
|
|
|
|
|
|
|
|
1. [User's manual](#users-manual)<br/>
|
|
|
|
|
2. [System administrator](#system-administrator)<br/>
|
|
|
|
|
2.1. [Upgrades procedures](#upgrades-procedures)<br/>
|
|
|
|
|
3. [Translator's documentation](#translators-documentation)<br/>
|
|
|
|
|
4. [Developer's documentation](#developers-documentation)<br/>
|
|
|
|
|
4.1. [Architecture](#architecture)<br/>
|
|
|
|
|
4.2. [How to setup a development environment](#how-to-setup-a-development-environment)<br/>
|
|
|
|
|
4.3. [Externals](#externals)<br/>
|
|
|
|
|
4.4. [Diagrams](#diagrams)<br/>
|
|
|
|
|
|
2020-04-08 17:03:29 +02:00
|
|
|
### User's manual
|
|
|
|
|
The following guide describes what you can do and how to use Fab-manager.
|
2022-09-21 13:56:46 +02:00
|
|
|
- [Français](http://guide-fr.fab.mn/)
|
2020-04-14 10:05:48 +02:00
|
|
|
|
2020-04-08 17:03:29 +02:00
|
|
|
### System administrator
|
2020-04-14 10:05:48 +02:00
|
|
|
The following guides are designed for the people that perform software maintenance.
|
2020-04-08 17:44:48 +02:00
|
|
|
- [Setup and update a production environment](production_readme.md)
|
2020-04-08 17:03:29 +02:00
|
|
|
|
2022-06-13 15:22:01 +02:00
|
|
|
- [Installing behind a corporate proxy](proxy.md)
|
|
|
|
|
|
2020-04-08 17:03:29 +02:00
|
|
|
- [Configuring the environment variables](environment.md)
|
|
|
|
|
|
|
|
|
|
- [Known issues with Fab-Manager](known-issues.md)
|
|
|
|
|
|
|
|
|
|
- [Advanced PostgreSQL usage](postgresql_readme.md)
|
|
|
|
|
|
2021-10-22 16:50:18 +02:00
|
|
|
- [Connecting an SSO using oAuth 2.0](sso_with_github.md)
|
2022-04-20 15:22:23 +02:00
|
|
|
- [Connecting an SSO using OpenID Connect](sso_open_id_connect.md)
|
2020-04-08 17:03:29 +02:00
|
|
|
|
2020-04-14 10:05:48 +02:00
|
|
|
- [Upgrade from Fab-manager v1.0](upgrade_v1.md)
|
|
|
|
|
|
2021-10-22 16:50:18 +02:00
|
|
|
- [Configuring OpenProjects](open_projects.md)
|
|
|
|
|
|
2020-04-08 17:03:29 +02:00
|
|
|
#### Upgrades procedures
|
|
|
|
|
- [PostgreSQL](postgres_upgrade.md)
|
|
|
|
|
- [ElasticSearch](elastic_upgrade.md)
|
|
|
|
|
|
2020-04-15 15:44:18 +02:00
|
|
|
### Translator's documentation
|
2022-10-05 17:16:04 +02:00
|
|
|
If you intend to translate Fab-manager to a new, or an already supported language, you'll find here the information you need.
|
2020-04-15 15:44:18 +02:00
|
|
|
- [Guide for translators](translation_readme.md)
|
2020-04-08 17:03:29 +02:00
|
|
|
|
|
|
|
|
### Developer's documentation
|
2020-04-14 10:05:48 +02:00
|
|
|
The following guides should help those who want to contribute to the code.
|
2020-12-29 13:13:48 +01:00
|
|
|
#### Architecture
|
|
|
|
|
- [Code architecture](architecture.md)
|
|
|
|
|
|
2021-10-22 16:50:18 +02:00
|
|
|
- [Plugins](plugins.md)
|
|
|
|
|
|
2022-07-12 17:46:01 +02:00
|
|
|
- [How the data model works for Availabilities and Reservations](availabilities-reservations-models.md)
|
|
|
|
|
|
2020-04-08 17:03:29 +02:00
|
|
|
#### How to setup a development environment
|
|
|
|
|
- [With docker-compose](development_readme.md)
|
2020-04-14 10:05:48 +02:00
|
|
|
|
2020-04-08 17:03:29 +02:00
|
|
|
- [With vagrant](virtual-machine.md)
|
|
|
|
|
|
|
|
|
|
#### Externals
|
|
|
|
|
- [ElasticSearch mapping](elasticsearch.md)
|
|
|
|
|
|
2020-04-14 10:13:45 +02:00
|
|
|
- [Changing the database system](postgresql_readme.md#using-another-dbms)
|
2020-04-08 17:03:29 +02:00
|
|
|
|
|
|
|
|
#### Diagrams
|
2020-04-08 17:53:52 +02:00
|
|
|
- [Database diagram](database.svg)
|
2020-04-08 17:03:29 +02:00
|
|
|
|
2020-04-08 17:53:52 +02:00
|
|
|
- [Class diagram](class-diagram.svg)
|
2020-04-08 17:03:29 +02:00
|
|
|
|
2020-04-08 17:53:52 +02:00
|
|
|
- [Javascript dependencies](js-modules-dependencies.svg)
|
2020-04-08 17:03:29 +02:00
|
|
|
|
2020-06-16 16:47:38 +02:00
|
|
|
- [Ruby dependencies](gem-dependencies.svg)
|
