diff options
author | Dashie <dashie@sigpipe.me> | 2019-06-20 15:36:36 +0200 |
---|---|---|
committer | Dashie <dashie@sigpipe.me> | 2019-06-20 15:36:36 +0200 |
commit | 4aa69e0112b4821f4c27f28ff02907e031f94c1e (patch) | |
tree | d53a694da89c57db5574e84955abaa80e8f56d56 /README.md | |
parent | 77d166ed8856d186084b79e6ecbceab48d7ae46c (diff) |
Improve readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 42 |
1 files changed, 28 insertions, 14 deletions
@@ -1,15 +1,29 @@ -Reel2Bits -===================== +<h1 align="center"> + Reel2Bits +</h1> -<a href="https://drone.sigpipe.me/dashie/reel2bits"><img src="https://drone.sigpipe.me/api/badges/dashie/reel2bits/status.svg" alt="Build Status"/></a> -<a href="https://dev.sigpipe.me/dashie/reel2bits/src/branch/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg"/></a> -<img src="https://img.shields.io/badge/python-%3E%3D3.6-blue.svg"/> [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) +<p align="center"> + <a href="https://drone.sigpipe.me/dashie/reel2bits"><img src="https://drone.sigpipe.me/api/badges/dashie/reel2bits/status.svg" alt="Build Status"/></a> + <a href="https://dev.sigpipe.me/dashie/reel2bits/src/branch/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg"/></a> + <img src="https://img.shields.io/badge/python-%3E%3D3.6-blue.svg"/> + [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) +</p> -# Versions requirement +<p align="center"> + <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> +</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) (say bye-bye to debian stable, sorry) - try https://github.com/chriskuehl/python3.6-debian-stretch if you use debian stable -# Installation +## Installation Install a BDD (mysql is supported, SQLite maybe, PostgreSQL should be) Makes sure that encoding is/will be in UNICODE/UTF-8 git clone http://dev.sigpipe.me/dashie/reel2bits @@ -31,13 +45,13 @@ Reel2Bits Also install this tool : https://github.com/bbc/audiowaveform And adapt the path to it in config.py -# Creating an user +## 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 +## Production running sudo easy_install3 virtualenv sudo su - reel2bits @@ -65,21 +79,21 @@ Copy systemd services files ```docs/reel2bits-*.service``` to ```/etc/systemd/sy Use ```docs/reel2bits.nginx``` as vhost template for ```X-Accel-Redirect``` part. -# Docker +## Docker TODO -# Default config +## Default config - App Name: My reel2bits instance -# Workers +## Workers Run the workers using: $ celery worker -A tasks.celery --loglevel=error -# Licensing +## Licensing - MIT License -# Others projects inspired from +## Others projects inspired from - https://github.com/tsileo/microblog.pub from Little-Boxes - https://funkwhale.audio |