mirror of
https://github.com/taigaio/taiga-docker.git
synced 2025-07-27 16:04:24 +02:00
(chore) minor improvements on readme
This commit is contained in:
parent
5706cf128e
commit
9786dcf4bd
117
README.md
117
README.md
@ -1,12 +1,51 @@
|
||||
# Taiga Docker
|
||||
|
||||
## Documentation
|
||||
## Getting Started
|
||||
|
||||
Currently, we have authored three main documentation hubs:
|
||||
This section intends to explain how to get Taiga up and running in a
|
||||
simple two steps, using **docker** and **docker-compose**.
|
||||
|
||||
If you don't have docker installed, please follow installation
|
||||
instructions from docker.com: https://docs.docker.com/engine/install/
|
||||
|
||||
Additionally, it's necessary to have familiarity with Docker,
|
||||
docker-compose and Docker repositories.
|
||||
|
||||
|
||||
### Start the application
|
||||
|
||||
```sh
|
||||
$ ./launch-all.sh
|
||||
```
|
||||
|
||||
After some instants, when the application is stated you can proceed to create the superuser
|
||||
with the following script:
|
||||
|
||||
```sh
|
||||
$ ./taiga-manage.sh createsuperuser
|
||||
```
|
||||
|
||||
The `taiga-manage.sh` script lets launch manage.py commands on the
|
||||
back instance:
|
||||
|
||||
```sh
|
||||
$ ./taiga-manage.sh [COMMAND]
|
||||
```
|
||||
|
||||
Default access for the application is **http://localhost:9000**.
|
||||
|
||||
|
||||
As **EXTRA**: the default `launch-all.sh` script comes with
|
||||
[penpot](https://penpot.app), the open-source solution for design and
|
||||
prototyping. The default access for the penpot application is
|
||||
**http://locahost:9001**
|
||||
|
||||
If you give it a try and want configure it you can found all the
|
||||
neccessary documentation on [penpot github](https://github.com/penpot/penpot/tree/develop/docs)
|
||||
|
||||
And finally if you just want to launch Taiga standalone, you can use
|
||||
the `launch-taiga.sh` script instead of the `launch-all.sh`.
|
||||
|
||||
- **[API](https://taigaio.github.io/taiga-doc/dist/api.html)**: Our API documentation and reference for developing from Taiga API.
|
||||
- **[Documentation](https://taigaio.github.io/taiga-doc/dist/)**: If you need to install Taiga on your own server, this is the place to find some guides.
|
||||
- **[Taiga Resources](https://resources.taiga.io)**: This page is intended to be the support reference page for the users.
|
||||
|
||||
## Bug reports
|
||||
|
||||
@ -21,18 +60,26 @@ One of our fellow Taiga developers will search, find and hunt it as soon as poss
|
||||
|
||||
Please, before reporting a bug, write down how can we reproduce it, your operating system, your browser and version, and if it's possible, a screenshot. Sometimes it takes less time to fix a bug if the developer knows how to find it.
|
||||
|
||||
## Requirements
|
||||
|
||||
- docker
|
||||
- docker-compose
|
||||
## Taiga Documentation
|
||||
|
||||
Additionally, it's necessary to have familiarity with Docker, docker-compose and Docker repositories.
|
||||
Currently, we have authored three main documentation hubs:
|
||||
|
||||
## Simple customization
|
||||
- **[API](https://taigaio.github.io/taiga-doc/dist/api.html)**: Our API documentation and reference for developing from Taiga API.
|
||||
- **[Documentation](https://taigaio.github.io/taiga-doc/dist/)**: If you need to install Taiga on your own server, this is the place to find some guides.
|
||||
- **[Taiga Resources](https://resources.taiga.io)**: This page is intended to be the support reference page for the users.
|
||||
|
||||
There are some environment variables for a simple customization. Find them in the `docker-compose.yml` and `docker-compose-inits.yml`. The images are ready to work out of the box, although is strongly recommended to change some default values.
|
||||
|
||||
**Important** Don't forget to review environment variables in `docker-compose-inits.yml` as some of them are in both files.
|
||||
|
||||
## Configuration with Environment Variables
|
||||
|
||||
There are some environment variables for a simple customization. Find
|
||||
them in the `docker-compose.yml` and `docker-compose-inits.yml`. The
|
||||
images are ready to work out of the box, although is strongly
|
||||
recommended to change some default values.
|
||||
|
||||
**Important** Don't forget to review environment variables in
|
||||
`docker-compose-inits.yml` as some of them are in both files.
|
||||
|
||||
### taiga-db
|
||||
|
||||
@ -199,47 +246,31 @@ This vars will be used to connect to rabbitmq.
|
||||
|
||||
## Storage
|
||||
|
||||
We have 3 named volumes configured: `taiga-static-data` for statics, `taiga-media-data` for medias and `taiga-db-data` for the database.
|
||||
We have 3 named volumes configured: `taiga-static-data` for statics,
|
||||
`taiga-media-data` for medias and `taiga-db-data` for the database.
|
||||
|
||||
|
||||
## Complex customization
|
||||
## Complex customization (via configuration files)
|
||||
|
||||
For a complex customization, you can use configuration files, mapped to specific directories inside the containers.
|
||||
For a complex customization, you can use configuration files, mapped
|
||||
to specific directories inside the containers.
|
||||
|
||||
### 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.
|
||||
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`).
|
||||
|
||||
### 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.
|
||||
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.
|
||||
|
||||
|
||||
## Before running
|
||||
|
||||
You have to configure an admin user:
|
||||
```sh
|
||||
# ensure migrations are properly set
|
||||
$ ./launch-all.sh
|
||||
$ ./taiga-manage.sh createsuperuser
|
||||
```
|
||||
|
||||
## Up and running
|
||||
|
||||
|
||||
```sh
|
||||
$ ./launch-all.sh
|
||||
```
|
||||
|
||||
Default access for the application is **http://localhost:9000**.
|
||||
|
||||
|
||||
## One shot commands
|
||||
|
||||
`taiga-manage.sh` lets launch manage.py commands on the back instance:
|
||||
|
||||
```sh
|
||||
$ ./taiga-manage.sh [COMMAND]
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user