Add 'README.md'

This commit is contained in:
starnakin 2023-06-08 20:49:21 +00:00
parent 559a1e8590
commit 1cf9107355

39
README.md Normal file
View File

@ -0,0 +1,39 @@
# Placeholder Name
A plateform (http server) to manage esport team
## Installation
1. Download the project
``` bash
git clone https://git.chauvet.pro/bozogang
```
2. Go in
``` bash
cd bozogang
```
3. Build docker image
``` bash
docker build -t zeolak .
```
4. Edit the docker-compose.yml
`port`: change the port to what port do you want
`path/to/config`: change to the location of your Placeholder Name config
5. Launch the docker
``` bash
docker-compose up -d
```
6. Edit the config
setup the database acces
7. Relauch the docker
``` bash
docker-compose up -d
```
## Update
1. Update the docker image
``` bash
docker build -t zeolak --no-cache .
```
2. Relaunch the docker
``` bash
docker-compose up -d
```