Yadciel/Titan
1
0
Fork 0
mirror of https://github.com/TitanEmbeds/Titan.git synced 2024-12-25 14:37:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Self hosting (markdown)

Jelle Z 2018-09-12 23:22:01 +02:00
parent 5120fa17a7
commit 8ffb15f9b6
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Self-hosting.md

@ -1,4 +1,5 @@
# Disp "Hold up!"
# puts 'Hold up!'
This wiki page will help you started with installing Titan on your own server. Under normal circumstances, it's recommended to let [Titan Embeds](https://titanembeds.com/) host your embeds. Hosting a copy of Titan yourself requires time, resources and a fair amount of knowledge!
# print("Let's get things running")
@ -7,6 +8,18 @@ There are two parts that integrate nicely together. The web app (website) handle
Once you cloned the project, install the Python dependencies with ``pip install -r requirements.txt``. Ensure that you are utilising Python 3.6's pip.
# <?php echo 'All your (data)base are belong to us'; ?>
Okay, not really, but you will have to set-up one in order to host Titan. To set up the database for it to work with the webapp and the discordbot, one must use alembic to migrate their databases to the current database state. To do so, please follow these instructions. PostgreSQL supports proper indexing and suitable for Titan needs. For this reason, Titan only supports using a PostgreSQL database.
1. Install alembic with Python 3.5's pip pip install alembic
2. Change your directory to the webapp where the alembic files are located cd webapp
3. Clone alembic.example.ini into your own alembic.ini file to find and edit the following line sqlalchemy.url to equal your database uri. See here if you need help understanding how database uri works in SQLalchemy.
4. In your terminal, run alembic upgrade head to upgrade your database tables to the current version on git. As long as there are only INFO messages and no errors, you should be fine.
5. Check your database tables to see if they are created. If so, you have finished migrating your database! Remember to run Step 4 every now and then just in case if there are database updates. (Presumably on every git pull).
Titan also requires a Redis instance in order to function. There is no specific prerequisites before utilizing Titan with Redis. Follow the [official Redis installation instructions to install](https://redis.io/topics/quickstart) and start using Redis.
# $ echo "Ansible Playbooks"
If you happen to have a copy of Ubuntu on your server, you may head onto our [Ansible Playbooks repository](https://github.com/TitanEmbeds/ansible-playbooks) and perform a near-to-automatic installation of Titan.