mirror of
https://github.com/taigaio/taiga-docker.git
synced 2025-07-31 01:44:39 +02:00
Update documentation
This commit is contained in:
parent
7c4d3eb694
commit
67568890c2
61
README.md
61
README.md
@ -16,23 +16,58 @@ There are some environment variables for a simple customization. Find them in th
|
||||
|
||||
**Important**: these vars should have the same values as `taiga-back` vars.
|
||||
|
||||
### API and Admin: taiga-back
|
||||
### API, Admin, and Async: taiga-back
|
||||
|
||||
**Database settings**:
|
||||
|
||||
`POSTGRES_DB`, `POSTGRES_USER` and `POSTGRES_PASSWORD`. This vars will be used to connect to the Taiga database.
|
||||
|
||||
**Important**: these vars should have the same values as `taiga-db` vars.
|
||||
*Important*: these vars should have the same values as `taiga-db` vars.
|
||||
|
||||
Besides, `POSTGRES_HOST` where the database is set. By default, it's meant to be in the same host as the database service so it uses internal docker names.
|
||||
|
||||
`TAIGA_PORT` should be the same as the exposed port in the `taiga-gateway`. Default is 9000.
|
||||
**Taiga settings**:
|
||||
|
||||
`TAIGA_SECRET_KEY` should be the same as this var in `taiga-events`
|
||||
`TAIGA_SECRET_KEY` should be the same as this var in `taiga-events` and `taiga-async`
|
||||
|
||||
`TAIGA_SITES_SCHEME` and `TAIGA_SITES_DOMAIN` should have the url where this is served: https[://]taiga.mycompany.com
|
||||
|
||||
**Email Settings**:
|
||||
|
||||
By default, email is configured with the *console* backend, which means that the emails will be shown in the stdout.
|
||||
If you have an smtp service, configure `ENABLE_EMAIL` to "True" and the rest of email settings.
|
||||
|
||||
**Rabbit settings**
|
||||
|
||||
`RABBITMQ_USER` and `RABBITMQ_PASS` are used to leave messages in the rabbitmq services. Those variables should be the same as in `taiga-async-rabbitmq` and `taiga-events-rabbitmq`.
|
||||
|
||||
**Github settings**
|
||||
|
||||
Used for login with Github.
|
||||
Get these in your profile https://github.com/settings/apps or in your organization profile https://github.com/organizations/{ORGANIZATION-SLUG}/settings/applications
|
||||
|
||||
**Gitlab settings**
|
||||
|
||||
Used for login with GitLab.
|
||||
Get these in your profile https://{YOUR-GITLAB}/profile/applications or in your organization profile https://{YOUR-GITLAB}/admin/applications
|
||||
|
||||
`RABBITMQ_USER` and `RABBITMQ_PASS` are used to leave messages in rabbitmq.
|
||||
|
||||
### Front: taiga-front
|
||||
|
||||
`TAIGA_PORT` should be the same as the exposed port in the `taiga-gateway`. Default is 9000.
|
||||
`TAIGA_URL` where this Taiga instance should be served. It should be the same as `TAIGA_SITES_SCHEME`://`TAIGA_SITES_DOMAIN`.
|
||||
|
||||
`TAIGA_WEBSOCKETS_URL` to connect to the events. This should have the same value as `TAIGA_SITES_DOMAIN`, ie: ws://taiga.mycompany.com
|
||||
|
||||
**Github settings**
|
||||
|
||||
Used for login with Github.
|
||||
Get these in your profile https://github.com/settings/apps or in your organization profile https://github.com/organizations/{ORGANIZATION-SLUG}/settings/applications
|
||||
|
||||
**Gitlab settings**
|
||||
|
||||
Used for login with GitLab.
|
||||
Get these in your profile https://{YOUR-GITLAB}/profile/applications or in your organization profile https://{YOUR-GITLAB}/admin/applications
|
||||
|
||||
|
||||
### Events: taiga-events
|
||||
|
||||
@ -44,13 +79,13 @@ Besides, `POSTGRES_HOST` where the database is set. By default, it's meant to be
|
||||
|
||||
For a complex customization, you can use configuration files, mapped to a specific directories inside the containers.
|
||||
|
||||
### API and Admin: taiga-back
|
||||
**taiga-back**
|
||||
|
||||
Map a Python configuration file to `/taiga-back/settings/config.py`. You can use (this file)[https://github.com/taigaio/taiga-back/blob/taiga-6/docker/config.py] as an example.
|
||||
|
||||
**Important**: if you use your own configuration file, don't forget to add contribs to `INSTALLED_APPS` (check the example `config.py`).
|
||||
*Important*: if you use your own configuration file, don't forget to add contribs to `INSTALLED_APPS` (check the example `config.py`).
|
||||
|
||||
### Front: taiga-front
|
||||
**taiga-front**
|
||||
|
||||
Map a `conf.json`configuration file to `/usr/share/nginx/html/conf.json`. You can use (this file)[https://github.com/taigaio/taiga-front/blob/taiga-6/docker/conf.json.template] as an example.
|
||||
|
||||
@ -78,11 +113,3 @@ Default access for the application is **http://localhost:9000**.
|
||||
```sh
|
||||
$ docker-compose -f docker-compose.yml -f docker-compose-inits.yml run --rm taiga-manage [COMMAND]
|
||||
```
|
||||
|
||||
## Sample data
|
||||
|
||||
This command, optional, some sample data to test the environment. It's important to run it **after running once the application** (which applies migrations). Otherwise, this command will fail.
|
||||
|
||||
```sh
|
||||
$ docker-compose -f docker-compose.yml -f docker-compose-inits.yml run --rm taiga-sampledata
|
||||
```
|
||||
|
@ -19,14 +19,6 @@ x-volumes:
|
||||
# - ./config.py:/taiga-back/settings/config.py:ro
|
||||
|
||||
services:
|
||||
taiga-sampledata:
|
||||
image: taigaio/taiga-back:alpha
|
||||
environment: *default-back-environment
|
||||
depends_on:
|
||||
- taiga-db
|
||||
entrypoint: bash -c "python manage.py sample_data"
|
||||
volumes: *default-back-volumes
|
||||
|
||||
taiga-manage:
|
||||
image: taigaio/taiga-back:alpha
|
||||
environment: *default-back-environment
|
||||
|
@ -2,13 +2,15 @@ version: "3.8"
|
||||
|
||||
x-environment:
|
||||
&default-back-environment
|
||||
# Database settings
|
||||
POSTGRES_DB: taiga
|
||||
POSTGRES_USER: taiga
|
||||
POSTGRES_PASSWORD: taiga
|
||||
POSTGRES_HOST: taiga-db
|
||||
# Taiga settings
|
||||
TAIGA_SECRET_KEY: "taiga-back-secret-key"
|
||||
TAIGA_SITES_DOMAIN: "localhost:9000"
|
||||
TAIGA_SITES_SCHEME: "http"
|
||||
TAIGA_SECRET_KEY: "taiga-back-secret-key"
|
||||
# Email settings
|
||||
ENABLE_EMAIL: "False" # False -> console; True -> smtp
|
||||
DEFAULT_FROM_EMAIL: "no-reply@example.com"
|
||||
@ -19,7 +21,7 @@ x-environment:
|
||||
# EMAIL_HOST_USER: "user"
|
||||
# EMAIL_HOST_PASSWORD: "password"
|
||||
# Rabbitmq settings
|
||||
# should be the same as in taiga-rabbitmq and taiga-events services
|
||||
# should be the same as in taiga-async-rabbitmq and taiga-events-rabbitmq
|
||||
RABBITMQ_USER: taiga
|
||||
RABBITMQ_PASS: taiga
|
||||
# Github settings
|
||||
|
Loading…
x
Reference in New Issue
Block a user