1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-12-22 08:56:17 +00:00
supysonic/docs/setup/index.rst

44 lines
1.1 KiB
ReStructuredText
Raw Permalink Normal View History

2021-01-09 15:05:49 +00:00
Supysonic setup
===============
2021-01-16 16:03:42 +00:00
This guide details the required steps to get a Supysonic instance ready to
2021-01-09 15:05:49 +00:00
start serving your music.
2021-01-17 16:06:44 +00:00
.. rubric:: TL;DR
2021-01-17 11:29:37 +00:00
For the impatient, here's a quick summary to get Supysonic installed and ready
to start serving (but this doesn't create any user nor specifies where your
music is located 😏). This uses `gunicorn`__, but there are
:doc:`other options <deploying/index>`.
::
pip install supysonic
2021-01-17 11:29:37 +00:00
pip install gunicorn
supysonic-server
2021-01-17 11:29:37 +00:00
__ https://gunicorn.org/
2021-01-17 16:06:44 +00:00
.. rubric:: Table of contents
2021-01-17 11:29:37 +00:00
2021-01-09 15:05:49 +00:00
.. toctree::
2021-01-16 16:03:42 +00:00
:maxdepth: 2
2021-01-09 15:05:49 +00:00
2021-01-16 16:03:42 +00:00
install
database
configuration
deploying/index
daemon
2021-01-17 11:29:37 +00:00
.. _docker:
2021-01-17 16:06:44 +00:00
.. rubric:: Docker
2021-01-17 11:29:37 +00:00
Another solution rather than going through the whole setup process yourself is
to use a ready-to-use Docker image. While we don't provide images for Supysonic,
that didn't keep the community from creating some. Take a look on the
`Docker Hub`__ and pick one you like. For more details on their usage, please
refer to the readme of said images.
__ https://hub.docker.com/search?q=supysonic&type=image