mirror of
https://github.com/Redume/Kekkai.git
synced 2025-04-02 21:37:36 +03:00
Compare commits
4 commits
91bacafe80
...
b3aab3e7aa
Author | SHA1 | Date | |
---|---|---|---|
b3aab3e7aa | |||
c6f89c0ed0 | |||
6e8921d3fe | |||
f2b85ae0b0 |
4 changed files with 108 additions and 32 deletions
|
@ -10,7 +10,16 @@ export default defineConfig({
|
|||
social: {
|
||||
github: 'https://github.com/redume/kekkai',
|
||||
},
|
||||
sidebar: [],
|
||||
sidebar: [
|
||||
{
|
||||
label: 'Getting started',
|
||||
items: [
|
||||
{
|
||||
label: 'Docker', slug: 'getting-started/docker', badge: 'recommended'
|
||||
}
|
||||
],
|
||||
},
|
||||
],
|
||||
}),
|
||||
],
|
||||
});
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 96 KiB |
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='nginx.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='nginx.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>
|
|
@ -1,36 +1,17 @@
|
|||
---
|
||||
title: Welcome to Starlight
|
||||
description: Get started building your docs site with Starlight.
|
||||
template: splash
|
||||
hero:
|
||||
tagline: Congrats on setting up a new Starlight project!
|
||||
image:
|
||||
file: ../../assets/houston.webp
|
||||
actions:
|
||||
- text: Example Guide
|
||||
link: /guides/example/
|
||||
icon: right-arrow
|
||||
- text: Read the Starlight docs
|
||||
link: https://starlight.astro.build
|
||||
icon: external
|
||||
variant: minimal
|
||||
title: Home
|
||||
description: The first free Open-Source Tool for Saving Historical Currency data
|
||||
---
|
||||
|
||||
import { Card, CardGrid } from '@astrojs/starlight/components';
|
||||
## What is Kekkai?
|
||||
Kekkai — The first free Open-Source Tool for Saving Historical Currency data
|
||||
|
||||
## Next steps
|
||||
It is a simple tool for collecting historical currency data from open sources,
|
||||
with the ability to create currency exchange rate charts.
|
||||
|
||||
<CardGrid stagger>
|
||||
<Card title="Update content" icon="pencil">
|
||||
Edit `src/content/docs/index.mdx` to see this page change.
|
||||
</Card>
|
||||
<Card title="Add new content" icon="add-document">
|
||||
Add Markdown or MDX files to `src/content/docs` to create new pages.
|
||||
</Card>
|
||||
<Card title="Configure your site" icon="setting">
|
||||
Edit your `sidebar` and other config in `astro.config.mjs`.
|
||||
</Card>
|
||||
<Card title="Read the docs" icon="open-book">
|
||||
Learn more in [the Starlight Docs](https://starlight.astro.build/).
|
||||
</Card>
|
||||
</CardGrid>
|
||||
## Why Kekkai?
|
||||
|
||||
- Free & Open-Source
|
||||
- The ability to create graphs
|
||||
- Plausible support. Anonymous data collection with the ability to disable it.
|
||||
Available only to server owners
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue