mirror of
https://codeberg.org/catask-org/catask.git
synced 2025-04-20 13:53:42 -05:00
54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
# CatAsk on Docker (or Podman)
|
|
|
|
## Prerequisites
|
|
- Docker + `docker-compose` (or Podman + `podman-compose`)
|
|
|
|
## Steps
|
|
Before starting CatAsk, you must copy the configuration files to their proper places first:
|
|
|
|
```sh
|
|
cp config.example.json config.json
|
|
cp .env.example .env
|
|
```
|
|
|
|
Then, paste this into the `.env` file, and replace sections that are marked with `[CHANGE THIS]`.
|
|
|
|
```env
|
|
DB_HOST = postgres
|
|
DB_NAME = catask
|
|
DB_USER = catask
|
|
DB_PASS = catask
|
|
DB_PORT = 5432
|
|
ADMIN_PASSWORD = [CHANGE THIS]
|
|
APP_SECRET = [CHANGE THIS]
|
|
```
|
|
|
|
You may now start CatAsk:
|
|
|
|
```sh
|
|
docker compose up
|
|
```
|
|
|
|
If you have done everything correctly, going to `http://localhost:8000` in your browser should show a question box screen. You may now log in with your admin password, and configure the instance.
|
|
|
|
## Updating
|
|
|
|
1. Stop the Docker container
|
|
|
|
```sh
|
|
docker compose down
|
|
```
|
|
|
|
2. Follow the [`UPDATE.md`](./UPDATE.md) file to see what to add or remove to your `config.json` or `.env`.
|
|
|
|
3. Remove the Docker image
|
|
|
|
```sh
|
|
docker rmi catask_catask
|
|
```
|
|
|
|
4. Restart CatAsk
|
|
|
|
```sh
|
|
docker compose up
|
|
```
|