mirror of
https://github.com/Redume/Kekkai.git
synced 2025-02-24 13:11:24 +03:00
docs: Wrote a page to deploy the project via docker
This commit is contained in:
parent
f2b85ae0b0
commit
6e8921d3fe
2 changed files with 96 additions and 1 deletions
|
@ -10,7 +10,16 @@ export default defineConfig({
|
||||||
social: {
|
social: {
|
||||||
github: 'https://github.com/redume/kekkai',
|
github: 'https://github.com/redume/kekkai',
|
||||||
},
|
},
|
||||||
sidebar: [],
|
sidebar: [
|
||||||
|
{
|
||||||
|
label: 'Getting started',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Docker', slug: 'getting-started/docker', badge: 'recommended'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
86
docs/src/content/docs/getting-started/docker.mdx
Normal file
86
docs/src/content/docs/getting-started/docker.mdx
Normal file
|
@ -0,0 +1,86 @@
|
||||||
|
---
|
||||||
|
title: Docker
|
||||||
|
---
|
||||||
|
|
||||||
|
Docker Compose is the recommended method to run Kekkai in production.
|
||||||
|
Below are the steps to deploy Kekkai with Docker Compose.
|
||||||
|
|
||||||
|
Kekkai requires Docker Compose version 2.x.
|
||||||
|
|
||||||
|
import { Steps } from '@astrojs/starlight/components';
|
||||||
|
import { Code } from '@astrojs/starlight/components';
|
||||||
|
|
||||||
|
|
||||||
|
<Steps>
|
||||||
|
1. Preparing files
|
||||||
|
```
|
||||||
|
git clone https://github.com/redume/Kekkai
|
||||||
|
```
|
||||||
|
```
|
||||||
|
cd Kekkai
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Change config files
|
||||||
|
|
||||||
|
In nginx.conf, you need to specify your domain or ipv4 address
|
||||||
|
<Code code='
|
||||||
|
...
|
||||||
|
listen 443 ssl;
|
||||||
|
server_name localhost; # Your domain
|
||||||
|
...
|
||||||
|
' lang='txt' title='ngixn.conf' />
|
||||||
|
|
||||||
|
|
||||||
|
To set up SSL. Create folder `CertSSL`
|
||||||
|
```
|
||||||
|
mkdir CertSLL
|
||||||
|
```
|
||||||
|
|
||||||
|
After that, copy the SSL certificates to the CertSSL folder,
|
||||||
|
if the names are different,
|
||||||
|
then change either the name of the certificates or in `nginx.conf`
|
||||||
|
|
||||||
|
<Code code='
|
||||||
|
ssl_certificate /etc/nginx/ssl/fullchain.pem;
|
||||||
|
ssl_certificate_key /etc/nginx/ssl/privkey.pem;
|
||||||
|
' lang='txt' title='ngixn.conf' />
|
||||||
|
|
||||||
|
<Code code=
|
||||||
|
"
|
||||||
|
database:
|
||||||
|
user: 'DATABASE_USERNAME'
|
||||||
|
password: 'DATABASE_PASSWORD'
|
||||||
|
host: 'DATABASE_HOST'
|
||||||
|
name: 'DATABASE_NAME'
|
||||||
|
port: 5432
|
||||||
|
...
|
||||||
|
" lang='yaml' title='config.sample.yaml' />
|
||||||
|
Fill in the data in the database item, as well as in the .env config
|
||||||
|
|
||||||
|
|
||||||
|
<Code code='
|
||||||
|
# Connection secret for postgres. You should change it to a random password
|
||||||
|
# Please use only the characters `A-Za-z0-9`, without special characters or spaces
|
||||||
|
|
||||||
|
POSTGRES_PASSWORD=my_password
|
||||||
|
|
||||||
|
# If you do not know what you are doing, then you should not edit the values below
|
||||||
|
###################################################################################
|
||||||
|
POSTGRES_DB=kekkai
|
||||||
|
DB_HOST=postgres
|
||||||
|
POSTGRES_USER=postgres
|
||||||
|
' lang='txt' title='.env.sample' />
|
||||||
|
|
||||||
|
- Populate custom database information if necessary.
|
||||||
|
- Consider changing `DB_PASSWORD` to a custom value.
|
||||||
|
Postgres is not publically exposed,
|
||||||
|
so this password is only used for - local authentication.
|
||||||
|
To avoid issues with Docker parsing this value,
|
||||||
|
it is best to use only the characters `A-Za-z0-9`.
|
||||||
|
|
||||||
|
3. Start the containers
|
||||||
|
```shell
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
</Steps>
|
Loading…
Add table
Reference in a new issue