Merge pull request #2432 from getsentry/docs

Update installation directions to match 8.0.0

Author: mattrobenolt

docs/beacon.rst

@@ -15,7 +15,7 @@ The following information is reported:
 
 - A unique installation ID
 - The version of Sentry
-- A technical contact email (``SENTRY_ADMIN_EMAIL``)
+- A technical contact email (``system.admin-email``)
 - General anonymous statistics on the data pattern (such as the number of
   users)
 - Names and version of the installed Python modules

docs/config.rst

@@ -4,17 +4,12 @@ Configuring Sentry
 This document describes additional configuration options available to the
 Sentry server itself.
 
-.. describe:: SENTRY_URL_PREFIX
-
-    Absolute URL to the sentry root directory. Should not include a
-    trailing slash.
-
-    Defaults to ``""``.
-
-    ::
-
-        SENTRY_URL_PREFIX = 'http://sentry.example.com'
+First Install
+-------------
 
+During a new install, you will be prompted first for a walkthrough of the
+Installation Wizard. This wizard will help you get a few essential configuration
+options taken care of before beginning.
 
 Authentication
 --------------

docs/faq.rst

@@ -8,14 +8,14 @@ This document covers some frequently asked questions that come up.
 My sentry is running at **example.com:9000** but whenever I visit it I get
 redirected to **example.com**.
 
-    You likely have not correctly configured **SENTRY_URL_PREFIX**. See
+    You likely have not correctly configured **system.url-prefix**. See
     :doc:`config` for more information.
 
 .. class:: qa
 
 AJAX requests do not seem to work properly.
 
-    It's likely you have not correctly configured **SENTRY_URL_PREFIX**, so
+    It's likely you have not correctly configured **system.url-prefix**, so
     you're hitting CORS issues. See :doc:`config` for more information.
 
 .. class:: qa

docs/installation.rst

@@ -104,7 +104,30 @@ via ``sentry``, and get something like the following:
 .. code-block:: bash
 
   $ sentry
-  usage: [SENTRY_CONF=/path/to/settings.py] sentry [command] [options]
+  Usage: sentry [OPTIONS] COMMAND [ARGS]...
+
+    Sentry is cross-platform crash reporting built with love.
+
+  Options:
+    --config PATH  Path to configuration files.
+    --version      Show the version and exit.
+    --help         Show this message and exit.
+
+  Commands:
+    celery      Start background workers.
+    cleanup     Delete a portion of trailing data based on...
+    config      Manage runtime config options.
+    createuser  Create a new user.
+    devserver   Start a light Web server for development.
+    django      Execute Django subcommands.
+    export      Exports core metadata for the Sentry...
+    help        Show this message and exit.
+    import      Imports data from a Sentry export.
+    init        Initialize new configuration directory.
+    repair      Attempt to repair any invalid data.
+    shell       Run a Python interactive interpreter.
+    start       Start running a service.
+    upgrade     Perform any pending database migrations and...
 
 
 Installing from Source
@@ -141,12 +164,16 @@ Initializing the Configuration
 Now you'll need to create the default configuration. To do this, you'll
 use the ``init`` command You can specify an alternative configuration path
 as the argument to init, otherwise it will use the default of
-``~/.sentry/sentry.conf.py``.
+``~/.sentry``.
 
 ::
 
     # the path is optional
-    sentry init /www/sentry/sentry.conf.py
+    sentry init /etc/sentry
+
+Starting with 8.0.0, ``init`` now creates two files, ``sentry.conf.py`` and
+``config.yml``. To avoid confusion, ``config.yml`` will slowly be replacing
+``sentry.conf.py``, but right now, the uses of ``config.yml`` are limited.
 
 The configuration for the server is based on ``sentry.conf.server``, which
 contains a basic Django project configuration, as well as the default
@@ -170,9 +197,6 @@ not a fully supported database and should not be used in production**.
         }
     }
 
-    # No trailing slash!
-    SENTRY_URL_PREFIX = 'http://sentry.example.com'
-
 
 Configure Redis
 ---------------
@@ -243,14 +267,14 @@ Once done, you can create the initial schema using the ``upgrade`` command:
 
 .. code-block:: python
 
-    $ SENTRY_CONF=/www/sentry/sentry.conf.py sentry upgrade
+    $ SENTRY_CONF=/etc/sentry sentry upgrade
 
 Next up you'll need to create the first user, which will act as a superuser:
 
 .. code-block:: bash
 
     # create a new user
-    $ SENTRY_CONF=/www/sentry/sentry.conf.py sentry createuser
+    $ SENTRY_CONF=/etc/sentry sentry createuser
 
 All schema changes and database upgrades are handled via the ``upgrade``
 command, and this is the first thing you'll want to run when upgrading to
@@ -271,7 +295,7 @@ To start the built-in webserver run ``sentry start``:
 
 ::
 
-  SENTRY_CONF=/www/sentry/sentry.conf.py sentry start
+  SENTRY_CONF=/etc/sentry sentry start
 
 You should now be able to test the web service by visiting `http://localhost:9000/`.
 
@@ -283,7 +307,7 @@ in addition to the web service workers:
 
 ::
 
-  SENTRY_CONF=/www/sentry/sentry.conf.py sentry celery worker -B
+  SENTRY_CONF=/etc/sentry sentry celery worker -B
 
 See :doc:`queue` for more details on configuring workers.
 
@@ -358,7 +382,7 @@ go.
 
   [program:sentry-web]
   directory=/www/sentry/
-  environment=SENTRY_CONF="/www/sentry/sentry.conf.py"
+  environment=SENTRY_CONF="/etc/sentry"
   command=/www/sentry/bin/sentry start
   autostart=true
   autorestart=true
@@ -368,7 +392,7 @@ go.
 
   [program:sentry-worker]
   directory=/www/sentry/
-  environment=SENTRY_CONF="/www/sentry/sentry.conf.py"
+  environment=SENTRY_CONF="/etc/sentry"
   command=/www/sentry/bin/sentry celery worker -B
   autostart=true
   autorestart=true

docs/nginx.rst

@@ -95,7 +95,7 @@ confused)::
 Create a uWSGI configuration which references the Sentry configuration::
 
     [uwsgi]
-    env = SENTRY_CONF=/etc/sentry.conf.py
+    env = SENTRY_CONF=/etc/sentry
     module = sentry.wsgi
 
     ; spawn the master and 4 processes with 8 threads each
@@ -171,6 +171,8 @@ One rewrite is still required before the location block [#f1]_::
 Subpath with Sentry's Default Webserver
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. Note:: This method is unsupported and untested by the Sentry team.
+
 This is a bit more involved and harder to debug because not only does Nginx have to know the new location to listen for, it also must do rewriting of the urls it sends to the Sentry's built in server because it knows nothing about you trying to host the application elsewhere.
 
 These are not full configurations, but abbreviated versions to highlight the differences from the main examples.
@@ -199,9 +201,7 @@ Your Sentry settings file ($SENTRY_CONF python file)::
 
     ...
 
-    SENTRY_URL_PREFIX = 'http://yourdomain.com/sentry'
     FORCE_SCRIPT_NAME = '/sentry'
-
     ...
 
 .. rubric:: Footnotes

docs/performance.rst

@@ -41,7 +41,7 @@ uWSGI yourself by doing something along the lines of::
 	stopwaitsecs=10
 	stopasgroup=true
 	killasgroup=true
-	environment=SENTRY_CONF="/srv/www/getsentry.com/current/getsentry/settings.py"
+	environment=SENTRY_CONF="/etc/sentry"
 	directory=/srv/www/getsentry.com/current/
 	stdout_logfile syslog
 	stderr_logfile syslog
@@ -130,7 +130,7 @@ look to supervisord for managing this for us::
 	stopwaitsecs=10
 	stopasgroup=false
 	killasgroup=true
-	environment=SENTRY_CONF="/srv/www/getsentry.com/current/getsentry/settings.py"
+	environment=SENTRY_CONF="/etc/sentry"
 	directory=/srv/www/getsentry.com/current/