FoundKeyGang/FoundKey
FoundKeyGang
/
FoundKey
7
19
Fork 22
Code Issues 37 Pull Requests 4 Releases Activity

Add suggestions from @EpicKitty

This commit is contained in:
Norm 2023-02-23 15:05:06 -05:00
parent 139ccd2580
commit ecbe984315
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/install-docker.md
View File

@ -20,7 +20,7 @@ git clone https://akkoma.dev/FoundKeyGang/FoundKey.git
cd FoundKey
```
##Configure
## Configure
Copy example configuration files with following:
@ -31,6 +31,8 @@ cp ./docker-compose.yml.example ./docker-compose.yml
```
Edit `default.yml` and `docker.env` according to the instructions in the files.
You will need to set the database host to `db` and Redis host to `redis` in order to use the internal container network for these services.
Edit `docker-compose.yml` if necessary. (e.g. if you want to change the port).
@ -40,7 +42,7 @@ This will take some time.
``` shell
docker compose build
docker compose run --rm web pnpm run init
docker compose run --rm web yarn run init
```
## Launch
@ -50,6 +52,8 @@ You can start FoundKey with the following command:
docker compose up -d
```
In case you are encountering issues, you can run `docker compose logs -f` to get the log output of the running containers.
## How to update your FoundKey server
When updating, be sure to check the [release notes](https://akkoma.dev/FoundKeyGang/FoundKey/src/branch/main/CHANGELOG.md) to know in advance the changes and whether or not additional work is required (in most cases, it is not).