summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAlex <sleepy@sleepy.kiev.ua>2019-09-15 17:26:14 +0300
committerAlex <sleepy@sleepy.kiev.ua>2019-09-15 17:26:14 +0300
commit8aa2ce95b8007844da2b2206da0b828ce86c27c9 (patch)
tree38ec5c812bf3b38fcbb4c8950d0abc225d633852 /README.md
parent307988f80c9331ac790a8e8553e38ee8ffbd817c (diff)
parentae5aa93b407916f1accd0059515b2d08a63071bf (diff)
Merge remote-tracking branch 'upstream/frontv2' into frontv2
Diffstat (limited to 'README.md')
-rw-r--r--README.md77
1 files changed, 14 insertions, 63 deletions
diff --git a/README.md b/README.md
index 3ac14cf5..e235faec 100644
--- a/README.md
+++ b/README.md
@@ -15,70 +15,25 @@
<a href="https://sound.otter.sh/user/dashie">Example single user instance</a>
<a href="https://riot.im/app/#/room/#reel2bits:otter.sh">Matrix room: #reel2bits:otter.sh</a>
+ -
+ <a href="https://docs-develop.reel2bits.org">Installation & Documentation</a>
</p>
Reel2bits is a soundcloud-like self-hosted application. You can upload audio files and they get transcoded, and also compile them into albums.
ActivityPub federation is still a work in progress, everything else works.
-## Versions requirement
- - Python >= 3.6 (all under 3.6 are not supported)
-
## Installation
- Install PostgreSQL first for the database. MySQL or SQLITE3 are unsupported as we use PostgreSQL specific extensions.
- Makes sure that encoding is/will be in UNICODE/UTF-8
- git clone http://dev.sigpipe.me/dashie/reel2bits
- cd reel2bits
- pip3 install --requirement requirements.txt
- python3 setup.py install
- # Install Pydub dependencies: https://github.com/jiaaro/pydub#dependencies
- cp config.py.sample config.py
- $EDITOR config.py
- export FLASK_ENV=<development or production>
- $ create your postgresql database, like 'reel2bits'
- $ with the postgresql shell, run using superuser on the reel2bits database:
- CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
- flask db upgrade
- flask seed
- flask run
- Don't forget to update default Config by getting to "Your user" (top right) then "Config"
-
- Also install this tool : https://github.com/bbc/audiowaveform
- And adapt the path to it in config.py
-
-## Creating an user
-
-If you have enabled registration in config, the first user registered will be ADMIN !
-
-Or if you have disabled registration, use the ``` flask createuser ``` command to create an user.
-
-## Production running
-
- sudo easy_install3 virtualenv
- sudo su - reel2bits
- cd reel2bits
-
- >> install -> git part
-
- virtualenv -p /usr/bin/python3 venv
- or if python 3.6 from github repo:
- virtualenv -ppython3.6 venv
-
- source venv/bin/activate
- >> get back to install part
-
- pip install waitress
-
- # If you want SENTRY support (also add related things in config)
- pip install sentry-sdk[flask]
-
-
-Copy systemd services files ```docs/reel2bits-*.service``` to ```/etc/systemd/system/``` and adapt them to your setup.
-
- systemctl enable reel2bits-web reel2bits-worker
- systemctl start reel2bits-web reel2bits-worker
-
-Use ```docs/reel2bits.nginx``` as vhost template for ```X-Accel-Redirect``` part.
+
+The official documentation is available here: https://docs-develop.reel2bits.org/admin/index.html
+
+## Development notes
+
+The Developper documentation is available here: https://docs-develop.reel2bits.org/contributing.html
+
+## Translators documentation
+
+Refers to https://docs-develop.reel2bits.org/translators.html
## Development notes
@@ -113,15 +68,11 @@ TODO
## Default config
- App Name: My reel2bits instance
+ - App description: This is a reel2bits instance
-## Workers
- Run the workers using:
-
- $ celery worker -A tasks.celery --loglevel=error
-
## Licensing
- AGPL v3
## Others projects inspired from
- - https://github.com/tsileo/microblog.pub from Little-Boxes
+ - https://github.com/tsileo/microblog.pub from Little-Boxes ActivityPub backend
- https://funkwhale.audio