chore: add deployment instructions to README

This commit is contained in:
Sefa Eyeoglu 2022-02-19 19:15:46 +01:00
parent 799d5c3b85
commit c56f694ddd
No known key found for this signature in database
GPG Key ID: C10411294912A422

View File

@ -1,18 +1,32 @@
# PolyMC Meta
Scripts to generate jsons and jars that PolyMC will access.
## Deployment
It is recommended to use Docker to deploy the environment.
- Clone this repo to a server
- Make sure it's writable by the container later: `chown -R 1000:1000 .`
- Configure `config/config_local.sh`
- The defaults should be fine (apart from commiter email and name perhaps)
- Put your SSH key (which have push access to meta-upstream and meta-polymc) at `config/deploy.key`
- Customize docker-compose.yaml
- You might want to add `restart: always`
- Run `docker-compose up -d --build`
- Observer Cron logs using `docker-compose logs -f` (Runs hourly by default)
- (Optional) Run once to fill caches: `docker-compose run meta update`
## Usage
### Install the dependencies
As root:
```
sudo pip install requirements.txt
sudo pip install -r requirements.txt
```
Or as user:
```
pip install --user requirements.txt
pip install --user -r requirements.txt
```
### Initial setup
@ -33,4 +47,4 @@ This will run the main script and do its magic
```
./status.sh
```
```