2021-12-24 13:53:55 -08:00
|
|
|
NiceDB / NeoDB - Getting Start
|
|
|
|
==============================
|
|
|
|
This is a very basic guide with limited detail, contributions welcomed
|
|
|
|
|
|
|
|
Install
|
|
|
|
-------
|
|
|
|
Install PostgreSQL, Redis and Python if not yet
|
|
|
|
|
|
|
|
Setup database
|
|
|
|
```
|
|
|
|
CREATE DATABASE neodb ENCODING 'UTF8' LC_COLLATE='en_US.UTF-8' LC_CTYPE='en_US.UTF-8' TEMPLATE template0;
|
|
|
|
\c neodb;
|
|
|
|
CREATE EXTENSION hstore WITH SCHEMA public;
|
|
|
|
CREATE ROLE neodb with LOGIN ENCRYPTED PASSWORD 'abadface';
|
|
|
|
GRANT ALL ON DATABASE neodb TO neodb;
|
|
|
|
```
|
|
|
|
|
|
|
|
Create and edit your own configuration file (optional but very much recommended)
|
|
|
|
```
|
|
|
|
mkdir mysite && cp boofilsic/settings.py mysite/
|
|
|
|
export DJANGO_SETTINGS_MODULE=mysite.settings
|
|
|
|
```
|
|
|
|
|
|
|
|
Create and use `venv` as you normally would, then install packages
|
|
|
|
```
|
|
|
|
python3 -m pip install -r requirements.txt
|
|
|
|
```
|
|
|
|
|
|
|
|
Quick check
|
|
|
|
```
|
|
|
|
python3 manage.py check
|
|
|
|
```
|
|
|
|
|
|
|
|
Initialize database
|
|
|
|
```
|
2022-11-02 04:59:01 +00:00
|
|
|
python3 manage.py makemigrations users books movies games music sync mastodon management collection timeline
|
2021-12-24 13:53:55 -08:00
|
|
|
python3 manage.py migrate users
|
|
|
|
python3 manage.py migrate
|
|
|
|
```
|
|
|
|
|
|
|
|
Build static assets
|
|
|
|
```
|
|
|
|
python3 manage.py collectstatic
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
Start services
|
|
|
|
--------------
|
|
|
|
Make sure PostgreSQL and Redis are running
|
|
|
|
|
|
|
|
Start job queue server
|
|
|
|
```
|
|
|
|
export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES # required and only for macOS, otherwise it may crash
|
|
|
|
python3 manage.py rqworker --with-scheduler doufen export mastodon
|
|
|
|
```
|
|
|
|
|
|
|
|
Run web server in dev mode
|
|
|
|
```
|
|
|
|
python3 manage.py runserver 0.0.0.0:80
|
|
|
|
```
|
|
|
|
|
|
|
|
It should be ready to serve from here, to run web server for production, consider `gunicorn -w 8 boofilsic.wsgi` in systemd or sth similar
|
|
|
|
|
|
|
|
|
|
|
|
Migrate from an earlier version
|
|
|
|
-------------------------------
|
|
|
|
Update database
|
|
|
|
```
|
|
|
|
python3 manage.py makemigrations
|
|
|
|
python3 manage.py migrate
|
|
|
|
```
|
|
|
|
|
|
|
|
Rebuild static assets
|
|
|
|
```
|
|
|
|
python3 manage.py sass common/static/sass/boofilsic.sass common/static/css/boofilsic.min.css -t compressed
|
|
|
|
python3 manage.py sass common/static/sass/boofilsic.sass common/static/css/boofilsic.css
|
|
|
|
python3 manage.py collectstatic
|
|
|
|
```
|
|
|
|
|
2022-07-31 03:07:11 -04:00
|
|
|
Add Cron Jobs
|
|
|
|
-------------
|
|
|
|
add `python manage.py refresh_mastodon` to crontab to run hourly, it will refresh cached users' follow/mute/block from mastodon
|
|
|
|
|
2022-07-31 02:37:59 -04:00
|
|
|
Index and Search
|
|
|
|
----------------
|
|
|
|
Install TypeSense or Meilisearch, change `SEARCH_BACKEND` and coniguration for search server in `settings.py`
|
|
|
|
|
|
|
|
Build initial index, it may take a few minutes or hours
|
|
|
|
```
|
|
|
|
python3 manage.py init_index
|
|
|
|
python3 manage.py reindex
|
|
|
|
```
|
2021-12-24 13:53:55 -08:00
|
|
|
|
|
|
|
Other maintenance tasks
|
|
|
|
-----------------------
|
|
|
|
Requeue failed jobs
|
|
|
|
```
|
|
|
|
rq requeue --all --queue doufen
|
|
|
|
```
|
2022-09-13 15:47:35 -04:00
|
|
|
|
|
|
|
Run in Docker
|
|
|
|
```
|
|
|
|
docker-compose build
|
|
|
|
docker-compose up db && docker exec -it app_db_1 psql -U postgres postgres -c 'CREATE EXTENSION hstore WITH SCHEMA public;' # first time only
|
|
|
|
docker-compose up
|
|
|
|
```
|
2022-11-10 14:17:48 -05:00
|
|
|
|
|
|
|
Run Tests
|
|
|
|
```
|
|
|
|
psql template1 -c 'create extension hstore;' # first time only
|
|
|
|
coverage run --source='.' manage.py test
|
|
|
|
coverage report
|
|
|
|
```
|
|
|
|
|