Skip to content
Permalink
Browse files
Improve admin user requirement warnings, closes #501 (#529)
  • Loading branch information
wohali committed Apr 28, 2020
1 parent 0b5a6b9 commit dc53c0ccc13fc2584c2c44b06596e3507714cc84
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 8 deletions.
@@ -26,6 +26,10 @@ Installation from ports
This will install CouchDB from the ports collection.

.. note::
Be sure to :ref:`create an admin user<config/admins>` before starting
CouchDB for the first time!

Start script
------------

@@ -21,7 +21,8 @@ Installation via Snap
Apache CouchDB provides 'convenience binary' Snap builds through the
Ubuntu snapcraft repository under the name ``couchdb``. Only snaps built
from official stable CouchDB releases (``2.0``, ``2.1``, etc.) are available
through this channel.
through this channel. There are separate snap channels for each major
release stream, e.g. ``2.x``, ``3.x``, as well as a ``latest`` stream.

After `installing snapd`_, the CouchDB snap can be installed via::

@@ -16,6 +16,11 @@
Installation on Unix-like systems
=================================

.. warning::
CouchDB 3.0+ will not run without an admin user being created first.
Be sure to :ref:`create an admin user<config/admins>` before starting
CouchDB!

.. _install/unix/binary:

Installation using the Apache CouchDB convenience binary packages
@@ -128,12 +133,8 @@ joined together and configured consistently across all machines; **follow the**

$ sudo yum -y install epel-release && sudo yum -y install couchdb

Once installed, change the password and uncomment the following line in your ``/opt/couchdb/etc/local.ini`` configuration file::

.. code-block:: ini
[admins]
admin = password
Once installed, :ref:`create an admin user<config/admins>` by hand before
starting CouchDB, if your installer didn't do this for you already.

You can now start the service.

@@ -341,6 +342,10 @@ Update the permissions for your ini files::
First Run
=========

.. note::
Be sure to :ref:`create an admin user<config/admins>` before trying to
start CouchDB!

You can start the CouchDB server by running::

sudo -i -u couchdb /home/couchdb/bin/couchdb
@@ -42,6 +42,9 @@ If you are running a standalone (single) CouchDB node:
and merge any changes desired into your own local settings file(s).
#. Stop CouchDB.
#. Upgrade CouchDB in place.
#. Be sure to :ref:`create an admin user<config/admins>` if you do not have
one. CouchDB 3.0+ **require** an admin user to start (the admin party has
ended).
#. Start CouchDB.
#. Relax! You're done.

@@ -62,7 +62,8 @@ Upgrade Notes
...and so on. Documentation has been updated to reflect this change.
* :ghissue:`2389`: CouchDB 3.0 now requires a server admin user to be defined at
startup, or will print an error message and exit. (The Admin Party is now over.)
startup, or will print an error message and exit. If you do not have one, be sure
to :ref:`create an admin user<config/admins>`. (The Admin Party is now over.)

.. figure:: ../../images/23379351593_0c480537de_q.jpg
:align: center

0 comments on commit dc53c0c

Please sign in to comment.