diff --git a/docs/installation.rst b/docs/installation.rst index f268102b..4e7a7e54 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -22,56 +22,55 @@ Standalone Deployment Depending on your needs and technical knowledge, there are several options here. They are listed below, starting with the simplest option. +Deployment to Heroku (free tier) +-------------------------------- -Deployment to Heroku --------------------- + Heroku is a cloud platform that lets companies build, deliver, monitor and scale apps — we're the fastest way to go + from idea to URL, bypassing all those infrastructure headaches. -This is the fastest and simplest option, using the free tier of Heroku, -which is enough for 500-1.000 musical works, depending on their complexity. -If you need more, for $16 per month, the limit raises to hundreds of thousands, after which this tool is probably -no longer the right one. + -- https://www.heroku.com/what -.. raw:: html - -

First, you need to sign up with Heroku and/or log in. - Then press - here.

+Django-Music-Publisher can simply be deployed to a Free dyno (container) on Heroku with a free database with up to +10.000 rows. Depending on complexity of your metadata, this is enough for 500-1.000 musical works. -You will be taken to the form you need to fill out correctly. +If you need more, plans costing between $9 and $16 per months will increase the limits to hundreds of thousands of +works. If you ever need more, this will no longer be the right software anyway. -Select a name for your app, choose the region, and enter the Config Vars described next. +See https://www.heroku.com/pricing for details. -The first set is used for generating the superuser account. You should -change the password once you log in and delete these variables from Heroku dashboard. +You will have to sign up with Heroku at https://signup.heroku.com/ and verify your e-mail, +no payment information is required. -*Please be careful, Heroku orders the fields alphabetically, e.g. USERNAME comes -after PASSWORD.* +There are two ways to do it: -* ``DJANGO_SUPERUSER_EMAIL`` - email address for the administrator account -* ``DJANGO_SUPERUSER_PASSWORD`` - password for the administrator account -* ``DJANGO_SUPERUSER_USERNAME`` - password for the administrator account +* Guided deployment, which uses a wizard that helps you fill out the deployment form, and +* Direct deployment, which does not, but takes you directly to the deployment form. -From the rest of the fields about your publishing entity, only these are required. +Guided Deployment to Heroku ++++++++++++++++++++++++++++ -* ``PUBLISHER`` - the name of the publisher -* ``PUBLISHER_IPI_NAME`` - your IPI Name number -* ``PUBLISHER_SOCIETY_PR`` - numeric code of your collecting society +The author and maintainer of Django-Music-Publisher runs a +`professional support service `_, +providing automatic feature upgrades, security/bugfix updates, maintenance and user support. -All Config Vars can be changed at any point in the Heroku Dashboard. +It also provides a free (no registration required) +`pre-installation wizard `_ that fills out the deployment +form on Heroku. However, you can only select collecting societies (PROs, MROs, etc.) where batch registration +process and rules compatibility with Django-Music-Publisher has been verified. -Please note that the data you enter must be valid, otherwise the installation -will fail. If you fail to get the values right, you may test the next option. +Direct Deployment ++++++++++++++++++ -Professional support ---------------------------- +.. raw:: html -The author and maintainer of Django-Music-Publisher runs a -`professional support service `_, -providing automatic upgrades and security/bugfix updates, maintenance and user support. +

First, you need to sign up with Heroku and/or log in. + Then press + here.

-It also provides a free (no registration required) `pre-installation wizard `_ that fills out the form -mentioned in the previous section with correct values. +You will be taken directly to the deployment form. Please note that you must fill the form correctly, or +Django-Music-Publisher will not be deployed. This is by design. +See `Settings`_. Other options - manual deployment ---------------------------------- @@ -102,14 +101,8 @@ Affiliation settings Agreement-related settings ----------------------------------- -* ``REQUIRE_SAAN`` - Makes *Society-assigned agreement number* field required for controlled writers -* ``REQUIRE_PUBLISHER_FEE`` - Makes *Publisher Fee* field required for controlled writers * ``PUBLISHING_AGREEMENT_PUBLISHER_PR`` - Performance share transferred to the publisher, default is '0.5' (50%) * ``PUBLISHING_AGREEMENT_PUBLISHER_MR`` - Mechanical share transferred to the publisher, default is '1.0' (100%) * ``PUBLISHING_AGREEMENT_PUBLISHER_SR`` - Synchronization share transferred to the publisher, default is '1.0' (100%) - -The last setting is a fairly complex one. The default works for most publishers, 50% of performance and 100% of -mechanical and 100% of sync is collected by the publisher. - -Please contact your society or societies for details, as laws in some countries require -specific values, e.g. Netherlands. +* ``REQUIRE_SAAN`` - Makes *Society-assigned agreement number* field required for controlled writers +* ``REQUIRE_PUBLISHER_FEE`` - Makes *Publisher Fee* field required for controlled writers