steve
/
mybuddy
mirror of https://github.com/snachodog/mybuddy.git
1
0
Fork 0
Code Issues 3 Packages Projects 1 Releases Wiki Activity

Add syntax highlighting to relevant docs

This commit is contained in:
Christopher C. Wells 2022-02-26 16:20:35 -08:00
parent c19d6cc6b9
commit f258124f6e
1 changed files with 60 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
docs/setup/deployment.md
View File

@ -84,104 +84,114 @@ and any number of children).
sudo apt-get install python3 python3-pip nginx uwsgi uwsgi-plugin-python3 git libopenjp2-7-dev libpq-dev sudo apt-get install python3 python3-pip nginx uwsgi uwsgi-plugin-python3 git libopenjp2-7-dev libpq-dev
1. Default python3 to python for this session 2. Default python3 to python for this session
alias python=python3 alias python=python3
1. Install pipenv 3. Install pipenv
sudo -H pip3 install pipenv sudo -H pip3 install pipenv
1. Set up directories and files 4. Set up directories and files
sudo mkdir /var/www/babybuddy sudo mkdir /var/www/babybuddy
sudo chown $USER:$(id -gn $USER) /var/www/babybuddy sudo chown $USER:$(id -gn $USER) /var/www/babybuddy
mkdir -p /var/www/babybuddy/data/media mkdir -p /var/www/babybuddy/data/media
git clone https://github.com/babybuddy/babybuddy.git /var/www/babybuddy/public git clone https://github.com/babybuddy/babybuddy.git /var/www/babybuddy/public
1. Move in to the application folder 5. Move in to the application folder
cd /var/www/babybuddy/public cd /var/www/babybuddy/public
1. Initiate and enter a Python environment with Pipenv locally. 6. Initiate and enter a Python environment with Pipenv locally.
export PIPENV_VENV_IN_PROJECT=1 export PIPENV_VENV_IN_PROJECT=1
pipenv install --three pipenv install --three
pipenv shell pipenv shell
1. Create a production settings file and set the ``SECRET_KEY`` and ``ALLOWED_HOSTS`` values 7. Create a production settings file and set the ``SECRET_KEY`` and ``ALLOWED_HOSTS`` values
cp babybuddy/settings/production.example.py babybuddy/settings/production.py cp babybuddy/settings/production.example.py babybuddy/settings/production.py
editor babybuddy/settings/production.py editor babybuddy/settings/production.py
1. Initiate the application 8. Initiate the application
export DJANGO_SETTINGS_MODULE=babybuddy.settings.production export DJANGO_SETTINGS_MODULE=babybuddy.settings.production
python manage.py migrate python manage.py migrate
python manage.py createcachetable python manage.py createcachetable
1. Set appropriate permissions on the database and data folder 9. Set appropriate permissions on the database and data folder
sudo chown -R www-data:www-data /var/www/babybuddy/data sudo chown -R www-data:www-data /var/www/babybuddy/data
sudo chmod 640 /var/www/babybuddy/data/db.sqlite3 sudo chmod 640 /var/www/babybuddy/data/db.sqlite3
sudo chmod 750 /var/www/babybuddy/data sudo chmod 750 /var/www/babybuddy/data
1. Create and configure the uwsgi app 10. Create and configure the uwsgi app
sudo editor /etc/uwsgi/apps-available/babybuddy.ini sudo editor /etc/uwsgi/apps-available/babybuddy.ini
Example config: Example config:
[uwsgi] ```ini
plugins = python3 [uwsgi]
project = babybuddy plugins = python3
base_dir = /var/www/babybuddy project = babybuddy
base_dir = /var/www/babybuddy
chdir = %(base_dir)/public chdir = %(base_dir)/public
virtualenv = %(chdir)/.venv virtualenv = %(chdir)/.venv
module = %(project).wsgi:application module = %(project).wsgi:application
env = DJANGO_SETTINGS_MODULE=%(project).settings.production env = DJANGO_SETTINGS_MODULE=%(project).settings.production
master = True master = True
vacuum = True vacuum = True
```
See the [uWSGI documentation](http://uwsgi-docs.readthedocs.io/en/latest/) See the [uWSGI documentation](http://uwsgi-docs.readthedocs.io/en/latest/)
for more advanced configuration details. for more advanced configuration details.
1. Symlink config and restart uWSGI: See [Subdirectory configuration](subdirectory.md) for additional configuration
required if Baby Buddy will be hosted in a subdirectory of another server.
sudo ln -s /etc/uwsgi/apps-available/babybuddy.ini /etc/uwsgi/apps-enabled/babybuddy.ini 11. Symlink config and restart uWSGI:
sudo service uwsgi restart
1. Create and configure the nginx server sudo ln -s /etc/uwsgi/apps-available/babybuddy.ini /etc/uwsgi/apps-enabled/babybuddy.ini
sudo service uwsgi restart
sudo editor /etc/nginx/sites-available/babybuddy 12. Create and configure the nginx server
Example config: sudo editor /etc/nginx/sites-available/babybuddy
upstream babybuddy { Example config:
server unix:///var/run/uwsgi/app/babybuddy/socket;
}
server { ```nginx
listen 80; upstream babybuddy {
server_name babybuddy.example.com; server unix:///var/run/uwsgi/app/babybuddy/socket;
}
location / { server {
uwsgi_pass babybuddy; listen 80;
include uwsgi_params; server_name babybuddy.example.com;
}
location /media { location / {
alias /var/www/babybuddy/data/media; uwsgi_pass babybuddy;
} include uwsgi_params;
} }
See the [nginx documentation](https://nginx.org/en/docs/) for more advanced location /media {
configuration details. alias /var/www/babybuddy/data/media;
}
}
```
1. Symlink config and restart NGINX: See the [nginx documentation](https://nginx.org/en/docs/) for more advanced
configuration details.
sudo ln -s /etc/nginx/sites-available/babybuddy /etc/nginx/sites-enabled/babybuddy See [Subdirectory configuration](subdirectory.md) for additional configuration
sudo service nginx restart required if Baby Buddy will be hosted in a subdirectory of another server.
1. That's it (hopefully)! :tada: 14. Symlink config and restart NGINX:
sudo ln -s /etc/nginx/sites-available/babybuddy /etc/nginx/sites-enabled/babybuddy
sudo service nginx restart
15. That's it (hopefully)!