michael/pyfedi
1
0
Fork 0
mirror of https://codeberg.org/rimu/pyfedi synced 2025-01-23 19:36:56 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update INSTALL.md

Browse source
This commit is contained in:
freamon 2024-03-05 19:54:17 +00:00
parent be952e8711
commit b8e4f6d022
1 changed files with 196 additions and 161 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

345
INSTALL.md
View file

@ -1,110 +1,91 @@
Mac OS # Contents
---
Install Python Version Manager (pyenv)
see this site: https://opensource.com/article/19/5/python-3-default-mac
brew install pyenv * [Setup Database](#setup-database)
* [Install Python Libraries](#install-python-libraries)
* [Install redis-server and git](#install-redis-server-and-git)
* [Setup pyfedi](#setup-pyfedi)
* [Setup .env file](#setup-env-file)
* [Initialise Database and Setup Admin account](#initialise-database-and-setup-admin-account)
* [Run the app](#run-the-app)
* [Database Management](#database-management)
* [Keeping your local instance up to date](#keeping-your-local-instance-up-to=date)
* [Running PieFed in production](#running-piefed-in-production)
* [Pre-requisites for Mac OS](#pre-requisites-for-mac-os)
* [Notes for Windows (WSL2)](#notes-for-windows-wsl2)
* [Notes for Pip Package Management](#notes-for-pip-package-management)
Install Python3 version and set as default (with pyenv) <div id="setup-database"></div>
pyenv install 3.8.6 ## Setup Database
pyenv global 3.7.3
Note.. #### Install postgresql 16
You may see this error when running `pip install -r requirements.txt` in regards to psycopg2:
ld: library not found for -lssl For installation environments that use 'apt' as a package manager:
clang: error: linker command failed with exit code 1 (use -v to see invocation)
error: command 'clang' failed with exit status 1
If this happens try installing openssl... `sudo apt install ca-certificates pkg-config`
Install openssl with brew install openssl if you don't have it already. `wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -`
`sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main" >> /etc/apt/sources.list.d/pgdg.list'`
`sudo apt update`
`sudo apt install libpq-dev postgresql`
brew install openssl #### Create new DB user
Add openssl path to LIBRARY_PATH : Choose a username and password. To use 'pyfedi' for both:
`sudo -iu postgres psql -c "CREATE USER pyfedi WITH PASSWORD 'pyfedi';"`
export LIBRARY_PATH=$LIBRARY_PATH:/usr/local/opt/openssl/lib/ #### Create new database
Linux Choose a database name, owned by your new user. For a database called and owned by 'pyfedi':
--- `sudo -iu postgres psql -c "CREATE DATABASE pyfedi WITH OWNER pyfedi;"`
install these additional packages
```sudo apt install python3-psycopg2 libpq-dev python3-dev redis-server``` <div id="install-python-libraries"></div>
## Install Python Libraries
[Pre-requisites for Mac OS](#pre-requisites-for-mac-os)
[Notes for Windows (WSL2)](#notes-for-windows-wsl2)
For installation environments that use 'apt' as a package manager:
`sudo apt install python3-pip python3-venv python3-dev python3-psycopg2`
Pip Package Management: <div id="install-redis-server-and-git"></div>
---
make sure you have 'wheel' installed: ## Install redis-server and git
```pip install wheel```
dump currently installed packages to file: For installation environments that use 'apt' as a package manager:
```pip freeze > requirements.txt``` `sudo apt install redis-server`
`sudo apt install git`
install packages from a file: <div id="setup-pyfedi"></div>
```pip install -r requirements.txt```
upgrade a package: ## Setup PyFedi
```pip install --upgrade <package_name>```
#### Clone PyFedi
`git clone https://codeberg.org/rimu/pyfedi.git`
--- #### cd into pyfedi, set up and enter virtual environment
`cd pyfedi`
`python3 -m venv ./venv`
`source venv/bin/activate`
#### Use pip to install requirements
`pip install wheel`
`pip install -r requirements.txt`
(see [Notes for Windows (WSL2)](#windows-wsl2) if appropriate)
Postgresql Setup: <div id="setup-env-file"></div>
---
installing postgresql https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-18-04
## Setup .env file
Windows (WSL 2 - Ubuntu 22.04 LTS - Python 3.9.16)
---
**Important**
Python 3.10+ or 3.11+ may cause some package or compatibility errors. If you are having issues installing packages from
requirements.txt, try using Python 3.8 or 3.9 instead with pyenv (https://github.com/pyenv/pyenv).
Follow all the setup instructions in the pyenv documentation and setup any version of either Python 3.8 or 3.9.
If you are getting installation errors or missing packages with pyenv, run
sudo apt update
sudo apt install build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev curl libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev llvm
Install Python 3, pip, and venv
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install python3 python3-pip ipython3 libpq-dev python3-psycopg2 python3-dev build-essential redis-server
sudo apt-get install python3-venv
Setup venv first before installing other packages
**Note**
(Replace <3.9> with your version number if you are using another version of Python,
e.g. 'sudo apt-get install python3.10-venv' for Python 3.10. Repeat for the rest of the instructions below.)
python3.9 -m venv ./venv
source venv/bin/activate
Make sure that your venv is also running the correct version of pyenv. You may need to re-setup venv if you setup venv before pyenv.
Follow the package installation instructions above to get the packages
python3.9 -m pip install --upgrade pip setuptools wheel
pip install -r requirements.txt
Continue with the .env setup and "Run API" sections below.
---
.env setup
---
Copy env.sample to .env Copy env.sample to .env
Edit .env to suit your server. Set the database connection up, something like this Edit .env to suit your server.
Using the same username, password, and database name as used when setting up database, set the connection up, something like this:
DATABASE_URL=postgresql+psycopg2://username:password@localhost/database_name DATABASE_URL=postgresql+psycopg2://username:password@localhost/database_name
Also change SECRET_KEY to some random sequence of numbers and letters. Also change SECRET_KEY to some random sequence of numbers and letters.
SERVER_NAME should be the domain of the site/instance. Use 127.0.0.1:5000 during development unless using ngrok. SERVER_NAME should be the domain of the site/instance. Use 127.0.0.1:5000 during development unless using ngrok.
@ -131,85 +112,63 @@ You can also [use environment variables](https://boto3.amazonaws.com/v1/document
Test email sending by going to https://yourdomain/test_email. It will try to send an email to the current user's email address. Test email sending by going to https://yourdomain/test_email. It will try to send an email to the current user's email address.
If it does not work check the log file at logs/pyfedi.log for clues. If it does not work check the log file at logs/pyfedi.log for clues.
--- <div id="initialise-database-and-setup-admin-account"></div>
## Initialise database, and set up admin account
`flask init-db`
(choose a new username, email address, and password for your PyFedi admin account)
Virtual Env setup (inside the root directory) <div id="run-the-app"></div>
---
python3 -m venv ./venv
pip install -r requirements.txt ## Run the app
`flask run`
(open web browser at http://127.0.0.1:5000)
(log in with username and password from admin account)
--- <div id="database-management"></div>
## Database Management
Database Setup In future if you use git pull and notice some new files in migrations/versions/*, you need to do:
---
Inside api dir
source venv/bin/activate (to set up virtual env if necessary)
export FLASK_APP=pyfedi.py
flask db upgrade
flask init-db
`source venv/bin/activate` (if not already in virtual environment)
`flask db upgrade`
In future if you use git pull and notice some new files in migrations/versions/*, you need to do #### For Database changes:
flask db upgrade
---
Run development server
---
export FLASK_APP=pyfedi.py
flask run
To enable debug mode and hot reloading, set the environment variable FLASK_ENV=development
export FLASK_ENV=development
export FLASK_APP=pyfedi.py
flask run
Make sure you have activated the venv by running
source venv/bin/activate
first!
Database Changes
---
create a migration based on recent changes to app/models.py: create a migration based on recent changes to app/models.py:
`flask db migrate -m "users table"`
run migrations:
`flask db upgrade`
flask db migrate -m "users table" <div id="keeping-your-local-instance-up-to=date"></div>
run migrations ## Keeping your local instance up to date
flask db upgrade
Keeping your local instance up to date
---
In a development environment, all you need to do is In a development environment, all you need to do is
git pull `git pull`
flask db upgrade `flask db upgrade`
In production, celery and flask run as background services so they need to be restarted manually. Run the `./deploy.sh` script In production, celery and flask run as background services so they need to be restarted manually. Run the `./deploy.sh` script
to easily restart services at the same time as pulling down changes from git, etc. to easily restart services at the same time as pulling down changes from git, etc.
Federation during development <div id="federation-during-development"></div>
---
## Federation during development
Federation doesn't work without SSL, without a domain name or without your server being accessible from outside your network. So, when running on http://127.0.0.1:5000 you have none of those. Federation doesn't work without SSL, without a domain name or without your server being accessible from outside your network. So, when running on http://127.0.0.1:5000 you have none of those.
The site will still run without federation. You can create local communities and post in them... The site will still run without federation. You can create local communities and post in them...
My way around this is to use ngrok.com, which is a quick and simple way to create a temporary VPN with a domain and SSL. On the free plan your domain changes every few days, which will break federation. $10 per month will get you https://yourwhatever.ngrok.app which won't change. My way around this is to use ngrok.com, which is a quick and simple way to create a temporary VPN with a domain and SSL. The free plan comes with ephermeral domain names that change every few days, which will break federation, or one randomly-named static domain that will need re-launching every few days. $10 per month will get you https://yourwhatever.ngrok.app which won't change.
Once you have ngrok working, edit the .env file and change the SERVER_NAME variable to your new domain name. Once you have ngrok working, edit the .env file and change the SERVER_NAME variable to your new domain name.
Running PieFed in production <div id="running-piefed-in-production"></div>
---
## Running PieFed in production
Copy celery_worker.default.py to celery_worker.py. Edit DATABASE_URL and SERVER_NAME to have the same values as in .env. Copy celery_worker.default.py to celery_worker.py. Edit DATABASE_URL and SERVER_NAME to have the same values as in .env.
@ -221,15 +180,14 @@ also [see this](https://pganalyze.com/blog/5mins-postgres-tuning-huge-pages).
(PgBouncer)[https://www.pgbouncer.org] can be helpful in a high traffic situation. (PgBouncer)[https://www.pgbouncer.org] can be helpful in a high traffic situation.
--- <div id="background-services"></div>
### Background services
Background services
---
Gunicorn and Celery need to run as background services: Gunicorn and Celery need to run as background services:
### Gunicorn #### Gunicorn
Create a new file: Create a new file:
@ -254,7 +212,7 @@ Add the following to the new file, altering paths as appropriate for your instal
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
### Celery #### Celery
Create another file: Create another file:
@ -305,7 +263,7 @@ Contents (change paths to suit):
CELERY_BIN=/home/rimu/pyfedi/venv/bin/celery CELERY_BIN=/home/rimu/pyfedi/venv/bin/celery
CELERYD_OPTS="--autoscale=5,1" CELERYD_OPTS="--autoscale=5,1"
### Enable and start background services #### Enable and start background services
sudo systemctl enable pyfedi.service sudo systemctl enable pyfedi.service
sudo systemctl enable celery.service sudo systemctl enable celery.service
@ -325,11 +283,7 @@ Inspect log files at:
/your_piefed_installation/logs/pyfedi.log /your_piefed_installation/logs/pyfedi.log
--- ### Nginx
Nginx
---
You need a reverse proxy that sends all traffic to port 5000. Something like: You need a reverse proxy that sends all traffic to port 5000. Something like:
@ -367,12 +321,9 @@ You need a reverse proxy that sends all traffic to port 5000. Something like:
The above is not a complete configuration - you will want to add more settings for SSL, etc. The above is not a complete configuration - you will want to add more settings for SSL, etc.
--- ### Cron tasks
Cron tasks
---
To send email reminders about unread notifications, put this in a new file under /etc/cron.d To send email reminders about unread notifications, put this in a new file under /etc/cron.d
``` ```
@ -387,27 +338,23 @@ Once a week or so it's good to run remove_orphan_files.sh to save disk space:
5 4 * * 1 rimu cd /home/rimu/pyfedi && /home/rimu/pyfedi/remove_orphan_files.sh 5 4 * * 1 rimu cd /home/rimu/pyfedi && /home/rimu/pyfedi/remove_orphan_files.sh
``` ```
--- ### Email
Email
---
Email can be sent either through SMTP or Amazon web services (SES). SES is faster but PieFed does not send much Email can be sent either through SMTP or Amazon web services (SES). SES is faster but PieFed does not send much
email so it probably doesn't matter which method you choose. email so it probably doesn't matter which method you choose.
### AWS SES #### AWS SES
PieFed uses Amazon's "boto3" module to connect to SES. Boto3 needs to log into AWS and that can be set up using a file PieFed uses Amazon's "boto3" module to connect to SES. Boto3 needs to log into AWS and that can be set up using a file
at ~/.aws/credentials or environment variables. Details at https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html. at ~/.aws/credentials or environment variables. Details at https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
In your .env you need to set the AWS region you're using for SES. Something like AWS_REGION = 'ap-southeast-2'. In your .env you need to set the AWS region you're using for SES. Something like AWS_REGION = 'ap-southeast-2'.
### SMTP #### SMTP
To use SMTP you need to set all the MAIL_* environment variables in you .env file. See env.sample for a list of them. To use SMTP you need to set all the MAIL_* environment variables in you .env file. See env.sample for a list of them.
### Testing email #### Testing email
You need to set MAIL_FROM in .env to some email address. You need to set MAIL_FROM in .env to some email address.
@ -415,3 +362,91 @@ Log into Piefed then go to https://yourdomain/test_email to trigger a test email
which environment variables you defined in .env. If MAIL_SERVER is empty it will try SES. Then if AWS_REGION is empty it'll which environment variables you defined in .env. If MAIL_SERVER is empty it will try SES. Then if AWS_REGION is empty it'll
silently do nothing. silently do nothing.
---
<div id="pre-requisites-for-mac-os"></div>
## Pre-requisites for Mac OS
#### Install Python Version Manager (pyenv)
see this site: https://opensource.com/article/19/5/python-3-default-mac
`brew install pyenv`
#### Install Python3 version and set as default (with pyenv)
`pyenv install 3.8.6`
`pyenv global 3.7.3`
Note..
You may see this error when running `pip install -r requirements.txt` in regards to psycopg2:
ld: library not found for -lssl
clang: error: linker command failed with exit code 1 (use -v to see invocation)
error: command 'clang' failed with exit status 1
If this happens try installing openssl...
Install openssl with brew install openssl if you don't have it already.
`brew install openssl`
Add openssl path to LIBRARY_PATH :
export LIBRARY_PATH=$LIBRARY_PATH:/usr/local/opt/openssl/lib/
---
<div id="notes-for-windows-wsl2"></div>
## Notes for Windows (WSL 2 - Ubuntu 22.04 LTS - Python 3.9.16)
**Important:**
Python 3.10+ or 3.11+ may cause some package or compatibility errors. If you are having issues installing packages from
requirements.txt, try using Python 3.8 or 3.9 instead with pyenv (https://github.com/pyenv/pyenv).
Follow all the setup instructions in the pyenv documentation and setup any version of either Python 3.8 or 3.9.
If you are getting installation errors or missing packages with pyenv, run
`sudo apt update`
`sudo apt install build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev curl libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev llvm`
#### Install Python 3, pip, and venv
`sudo apt-get update`
`sudo apt-get upgrade`
`sudo apt-get install python3 python3-pip ipython3 libpq-dev python3-psycopg2 python3-dev build-essential redis-server`
`sudo apt-get install python3-venv`
#### Setup venv first before installing other packages
**Note: **
(Replace <3.9> with your version number if you are using another version of Python,
e.g. 'sudo apt-get install python3.10-venv' for Python 3.10. Repeat for the rest of the instructions below.)
`python3.9 -m venv ./venv`
`source venv/bin/activate`
Make sure that your venv is also running the correct version of pyenv. You may need to re-setup venv if you setup venv before pyenv.
Follow the package installation instructions above to get the packages
`python3.9 -m pip install --upgrade pip setuptools wheel`
`pip install -r requirements.txt`
<div id="notes-for-pip-package-management"></div>
---
## Notes for Pip Package Management:
make sure you have 'wheel' installed:
`pip install wheel`
install packages from a file:
`pip install -r requirements.txt`
dump currently installed packages to file:
`pip freeze > requirements.txt`
upgrade a package:
`pip install --upgrade <package_name>`