Skip to content

Self Hosting

Ryu JuHeon edited this page Aug 19, 2021 · 3 revisions

This topic contains information about self-hosting.

If you are self-hosting, you can configure various settings.

There are two types of self-hosting.

If you are using an already finished docker image

If you build a docker image or run it yourself

Everything is explained here, so check it out

Databases

Relational db

Heliotrope supports various relational DBs through ORM.

Check the link for supported DBs

However, the recommended DB is MariaDB.

Please check the deployment environment for more information.

Non-relational database

Recommend MongoDB Atlas Cloud Database.

You can use self-hosted MongoDB, but keep in mind that you won't be able to use the search feature

Using an already finished docker image

WIP

Build a docker image or run itself

If you build it yourself or run it yourself, you can touch a lot of settings.

Clone repository

git clone https://github.com/Saebasol/Heliotrope.git
git checkout master

Install dependencies

python -m pip -U pip
pip install -r ./requirements/deps.txt

Change the mirroring item

You can replace index_file with something else on that line.

Items that can be replaced are as follows.

"index-all.nozomi"
"index-english.nozomi"
"index-korean.nozomi"
... and more

Change the mirroring interval

Please refer to that line.

The default is 3600 seconds (1 hour).

Docker Build

Just run docker build .

See here for more information

Run

python -m heliotrope
Clone this wiki locally