cube/myriad
2
1
Fork 0
Code Issues 29 Pull Requests Projects 2 Wiki Activity

Update deployment instructions

cube
2026-05-28 01:14:59 +00:00
parent 4889525b54
commit 0105911e7b
1 changed files with 2 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
deployment-instructions.md

@@ -85,10 +85,11 @@ sudo nano instance/config.py
SECRET_KEY = '(paste generated key here)' SECRET_KEY = '(paste generated key here)'
``` ```
Save and close the config file. Still in the tmux window and virtual environment, initialize the database: Save and close the config file. Still in the tmux window and virtual environment, initialize the database and create an admin account
``` ```
flask --app myriad init-db flask --app myriad init-db
flask --app myriad register-admin
``` ```
Start waitress. Use port 80 for serving over http directly, or 5000 if you are going to follow the upcoming instructions for a reverse proxy. Start waitress. Use port 80 for serving over http directly, or 5000 if you are going to follow the upcoming instructions for a reverse proxy.
@@ -97,16 +98,6 @@ Start waitress. Use port 80 for serving over http directly, or 5000 if you are g
waitress-serve --port=5000 --call 'myriad:create_app' waitress-serve --port=5000 --call 'myriad:create_app'
``` ```
Go to a web browser, to the IP address of your server followed by the port (unless using 80, in which case no port is required, OR unless you are going to set up the reverse proxy before continuing. This might be a good idea if you are concerned about encryption while registering the first account). Navigate to Register and set up a username and password for at least one administrator account. Once this has been done, come back to the server, stop waitress with _CTRL+C_, and edit the config file to disable registration.
```
sudo nano instance/config.py
REGISTRATION = False
```
The login and registration links will now be removed, and you will need to go to /auth/login to login to Myriad. /auth/registration will no longer be accessible. The site is now ready to be used! We strongly recommend following the instructions to set up nginx as a reverse proxy and obtaining a certificate to serve Myriad over https, for your personal security.
# Updating Myriad # Updating Myriad
**WARNING: Before updating ALWAYS go to the administration settings page to back up your entire system to a downloadable zip file, so that your data can be restored if the database schema is updated.** It is always a good idea to check the repository for commits, and their notes, to see what's been updated, but I would still strongly recommend against updating Myriad without first backing up your data. **WARNING: Before updating ALWAYS go to the administration settings page to back up your entire system to a downloadable zip file, so that your data can be restored if the database schema is updated.** It is always a good idea to check the repository for commits, and their notes, to see what's been updated, but I would still strongly recommend against updating Myriad without first backing up your data.
@@ -153,19 +144,4 @@ Save and exit, then reload nginx.
``` ```
nginx -s reload nginx -s reload
```
# Config
Here's the default configuration again, if you need it.
```
REGISTRATION = True # Make sure to disable in production
ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif'}
ICON_UPLOAD_FOLDER = 'myriad/static/icons'
BLINKIES_UPLOAD_FOLDER = 'myriad/static/blinkies'
STAMPS_UPLOAD_FOLDER = 'myriad/static/stamps'
THEMES_FOLDER = 'myriad/static/themes'
TMP_FOLDER = 'myriad/static/tmp'
``` ```