contentdb/docs/getting_started.md

63 lines
1.7 KiB
Markdown
Raw Normal View History

2021-01-26 18:04:34 +01:00
# Getting started
Docker is the recommended way to develop and deploy ContentDB.
1. Install `docker` and `docker-compose`.
Debian/Ubuntu:
sudo apt install docker-ce docker-compose
2. Copy `config.example.cfg` to `config.cfg`.
1. Set `SECRET_KEY` and `WTF_CSRF_SECRET_KEY` to different random values.
3. (Optional) Set up mail in config.cfg.
Make sure to set `USER_ENABLE_EMAIL` to True.
4. (Optional) Set up GitHub integration
2023-06-18 23:07:46 +02:00
1. Make a GitHub OAuth Client at <https://github.com/settings/developers>:
2021-01-26 18:04:34 +01:00
2. Homepage URL - `http://localhost:5123/`
3. Authorization callback URL - `http://localhost:5123/user/github/callback/`
4. Put client id and client secret in `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` in config.cfg.
5. Create config.env:
POSTGRES_USER=contentdb
POSTGRES_PASSWORD=password
POSTGRES_DB=contentdb
FLASK_DEBUG=1
6. Start docker images:
docker-compose up --build
7. Setup database:
./utils/run_migrations.sh
8. Create initial data
1. `./utils/bash.sh`
2. Either `python utils/setup.py -t` or `python utils/setup.py -o`:
1. `-o` creates just the admin, and static data like tags, and licenses.
2. `-t` will do `-o` and also create test packages. (Recommended)
9. Make uploads writable:
sudo chown $(whoami):5123 -R data/uploads
10. View at <http://localhost:5123>.
2021-01-26 18:04:34 +01:00
The admin username is `rubenwardy` and the password is `tuckfrump`.
In the future, starting CDB is as simple as:
docker-compose up --build
To hot/live update CDB whilst it is running, use:
./utils/reload.sh
This will only work with python code and templates, it won't update tasks or config.
2022-02-06 23:58:13 +01:00
2022-02-07 00:08:42 +01:00
Now consider reading the [Developer Introduction](dev_intro.md).