mirror of
https://github.com/Redume/Kekkai.git
synced 2025-02-23 20:51:25 +03:00
1 line
26 KiB
JSON
1 line
26 KiB
JSON
|
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#what-is-kekkai","title":"What is Kekkai?","text":"<p>Kekkai \u2014 The first free Open-Source Tool for Saving Historical Currency data</p> <p>It is a simple tool for collecting historical currency data from open sources, with the ability to create currency exchange rate charts.</p>"},{"location":"#why-kekkai","title":"Why Kekkai?","text":"<ul> <li>Free & Open-Source</li> <li>The ability to create graphs</li> <li>Plausible support. Anonymous data collection with the ability to disable it. Available only to server owners</li> </ul>"},{"location":"config/conf-nginx/","title":"Configure nginx.conf","text":"<p>Kekkai is used by <code>Nginx</code> to redirect to the correct microservice.</p>"},{"location":"config/conf-nginx/#change-domain","title":"Change domain","text":"<p>Change localhost to your <code>domain</code> or <code>ipv4</code> based on your needs. If you need to use Kekkai locally, you don't need to change anything,</p> Note <pre><code>...\nserver_name localhost; # Your domain\n...\n</code></pre>"},{"location":"config/conf-nginx/#change-name-for-ssl","title":"Change name for SSL","text":"<p>This is where the name of the SSL files changes. This needs to be edited if you have a different one</p> <p>Change <code>privkey.pem</code> and <code>fullchain.pem</code> to the names of the files you have.</p> Note <pre><code>...\nssl_certificate /etc/nginx/ssl/fullchain.pem;\nssl_certificate_key /etc/nginx/ssl/privkey.pem;\n...\n</code></pre>"},{"location":"config/config-env/","title":"Configure .env","text":"<p>Kekkai can be configured using the <code>.env</code> file in the working directory. <code>.env.example</code>.</p> <p><code>.env</code> config is used to configure PosgreSQL running in Docker Compose.</p> <p>Info</p> <p>If you are not using Docker Compose, you do not need to edit this config</p> Example file <code>.env.example</code> <pre><code># Connection secret for postgres. You should change it to a random password\n# Please use only the characters `A-Za-z0-9`, without special characters or spaces\n\nPOSTGRES_PASSWORD=my_password\n\n# If you do not know what you are doing, then you should not edit the values below\n###################################################################################\nPOSTGRES_DB=kekkai\nDB_HOST=postgres\nPOSTGRES_USER=postgres\n</code></pre> <p>This config only edits the password for PosgreSQL.</p> <p>Please use only the characters <code>A-Za-z0-9</code>, without special characters or spaces</p>"},{"location":"config/config-yaml/","title":"Configure config.yaml","text":"<p>Kekkai can be configured using the <code>config.yaml</code> file in the working directory. <code>config.example.yaml</code>.</p> Example file <code>config.example.yaml</code> <pre><code># For more information, see the documentation\n# https://kekkai-docs.redume.su/\n\ndatabase:\n user: 'DATABASE_USERNAME'\n password: 'DATABASE_PASSWORD'\n host: 'DATABASE_HOST'\n name: 'DATABASE_NAME'\n port: 5432\nserver:\n host: '0.0.0.0'\n ssl:\n private_key: '/CertSSL/privkey.pem'\n cert: '/CertSSL/fullchain.pem'\n work: true\n log:\n print: true\n level: 'info'\nanalytics:\n plausible_api: 'https://plausible.io/api/event/'\n plausible_domain: 'PLAUSIBLE_DOMAIN'\n plausible_token: 'PLAUSIBLE_TOKEN'\n work: true\ncurrency:\n chart:\n save: false\n collecting:\n fiat: true\n schedule: '30 8 * * *'\n fiat:\n - USD\n - RUB\n - EUR\n - UAH\n - TRY\n - KZT\n</code></pre>"},{"location":"config/config-yaml/#database","title":"Database","text":"<p>Kekkai is used as a <code>PostgreSQL</code> database.</p> <p>Info</p> <p>If you installed Kekkai via Docker Compose, then install it in the <code>database.host</code> value of <code>postgres</code>. The rest of the data does not have to be filled in. They need to be filled in <code>.env</code>.</p> <p>What
|