-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Advertise convenience binaries for installation (#153)
Closes #141.
- Loading branch information
Showing
7 changed files
with
188 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
.. Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
.. use this file except in compliance with the License. You may obtain a copy of | ||
.. the License at | ||
.. | ||
.. http://www.apache.org/licenses/LICENSE-2.0 | ||
.. | ||
.. Unless required by applicable law or agreed to in writing, software | ||
.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
.. License for the specific language governing permissions and limitations under | ||
.. the License. | ||
.. _install/docker: | ||
|
||
======================= | ||
Installation via Docker | ||
======================= | ||
|
||
Apache CouchDB provides 'convenience binary' Docker images through | ||
Docker Hub at ``apache/couchdb``. The following tags are available: | ||
|
||
* ``latest``, ``2.1.0``: CouchDB 2.1, single node | ||
* ``1``, ``1.6``, ``1.6.1``: CouchDB 1.6.1 | ||
* ``1-couchperuser``, ``1.6-couchperuser``, ``1.6.1-couchperuser``: CouchDB | ||
1.6.1 with couchperuser plugin | ||
* ``2.0.0``: CouchDB 2.0, single node | ||
|
||
These images are built using Debian 8 (jessie), expose CouchDB on port | ||
``5984`` of the container, run everything as user ``couchdb``, and support | ||
use of a Docker volume for data at ``/opt/couchdb/data``. | ||
|
||
Note that you can also use the ``NODENAME`` environment variable to set the | ||
name of the CouchDB node inside the container. | ||
|
||
**Be sure to complete the** :ref:`First-time Setup <install/setup>` **steps for | ||
a single node or clustered installation.** | ||
|
||
Further details on the Docker configuration are available in our | ||
`couchdb-docker git repository`_. | ||
|
||
.. _couchdb-docker git repository: https://github.com/apache/couchdb-docker |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,6 +23,8 @@ Installation & First-Time Setup | |
windows | ||
mac | ||
freebsd | ||
docker | ||
snap | ||
setup | ||
upgrading | ||
troubleshooting |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
.. Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
.. use this file except in compliance with the License. You may obtain a copy of | ||
.. the License at | ||
.. | ||
.. http://www.apache.org/licenses/LICENSE-2.0 | ||
.. | ||
.. Unless required by applicable law or agreed to in writing, software | ||
.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
.. License for the specific language governing permissions and limitations under | ||
.. the License. | ||
.. _install/snap: | ||
|
||
===================== | ||
Installation via Snap | ||
===================== | ||
|
||
.. highlight:: sh | ||
|
||
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. | ||
|
||
After `installing snapd`_, the couchdb snap can be installed via:: | ||
|
||
$ sudo snap install couchdb | ||
|
||
CouchDB will be installed at ``/snap/couchdb``. Data will be stored at | ||
``/var/snap/couchdb/``. | ||
|
||
.. _installing snapd: https://snapcraft.io/docs/core/install | ||
|
||
Further details on the snap build process are available in our | ||
`couchdb-pkg git repository`_. | ||
|
||
.. _couchdb-pkg git repository: https://github.com/apache/couchdb-pkg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters