[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[afiskon]

Github user afiskon closed the pull request at:

https://github.com/apache/couchdb-documentation/pull/69


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[rnewson]

Github user rnewson commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80018627
  
--- Diff: src/install/unix.rst ---
@@ -229,10 +233,66 @@ CouchDB no longer ships with any daemonization 
scripts.
 
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
-straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+straightforward; if you have questions, contact the CouchDB
+`user mailing list 
`_
+or `IRC-channel #couchdb `_
+in FreeNode network.
+
+Let's consider configuring runit on Ubuntu 16.04. The following
+steps should be considered only as an example. Details will vary
+by operating system and distribution. Check your system's package
+management tools for specifics.
+
+Install ruinit::
+
+sudo apt-get install runit
+   
+Create a directory where logs will be written::
+
+sudo mkdir /var/log/couchdb
+sudo chown couchdb:couchdb /var/log/couchdb
+   
+Create directories that will contain runit configuration for CouchDB::
+
+sudo mkdir /etc/sv/couchdb
+sudo mkdir /etc/sv/couchdb/log
+   
+Create /etc/sv/couchdb/log/run script::
+
+#!/bin/sh
+exec svlogd -tt /var/log/couchdb
+
+Basically it determines where and how exactly logs will be written.
+See ``man svlogd`` for more details.
+
+Create /etc/sv/couchdb/run::
+
+#!/bin/sh
+export HOME=/home/couchdb
+exec 2>&1
+exec chpst -u couchdb /home/couchdb/bin/couchdb
+
+This script determines how exactly CouchDB will be launched.
+Feel free to add any additional arguments and environment
+variables here if necessary.
+
+Make scripts executable::
+
+sudo chmod u+x /etc/sv/couchdb/log/run
+sudo chmod u+x /etc/sv/couchdb/run
+   
+Then run::
+
+sudo ln -s /etc/sv/couchdb/ /etc/service/couchdb
+   
+In a few seconds runit will discover a new symlink and start CouchDB. You 
can control CouchDB service like this::
+
+sudo sv status couchdb
+sudo sv stop couchdb
+sudo sv start couchdb
 
-Naturally, you can configure systemd, launchd or SysV-init daemons to
-launch CouchDB and keep it running using standard configuration files.
+Naturally now CouchDB will start autamatically shortly after system starts.
--- End diff --

typo 'autamatically' -> 'automatically'


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[rnewson]

Github user rnewson commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80018509
  
--- Diff: src/install/unix.rst ---
@@ -229,10 +233,66 @@ CouchDB no longer ships with any daemonization 
scripts.
 
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
-straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+straightforward; if you have questions, contact the CouchDB
+`user mailing list 
`_
+or `IRC-channel #couchdb `_
+in FreeNode network.
+
+Let's consider configuring runit on Ubuntu 16.04. The following
+steps should be considered only as an example. Details will vary
+by operating system and distribution. Check your system's package
+management tools for specifics.
+
+Install ruinit::
--- End diff --

typo 'ruinit' -> 'runit'


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[rnewson]

Github user rnewson commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80018414
  
--- Diff: src/install/unix.rst ---
@@ -23,6 +23,10 @@ release are the canonical sources of installation 
information. However, many
 systems have gotchas that you need to be aware of. In addition, 
dependencies
 frequently change as distributions update their archives.
 
+**Hint**: It is worth considering using packaging tools such as LXC, Docker
--- End diff --

-1 on this hint. This file is how to install on unix, so unless there will 
be detailed instructions on how to do that with LXC/Docker/et al this paragraph 
is not helping our users.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[rnewson]

Github user rnewson commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80018495
  
--- Diff: src/install/unix.rst ---
@@ -229,10 +233,66 @@ CouchDB no longer ships with any daemonization 
scripts.
 
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
-straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+straightforward; if you have questions, contact the CouchDB
+`user mailing list 
`_
+or `IRC-channel #couchdb `_
+in FreeNode network.
+
+Let's consider configuring runit on Ubuntu 16.04. The following
--- End diff --

Too informal, the paragraph should be tightened to explain what runit is 
going to do that's valuable, and then how to configure it.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80014264
  
--- Diff: src/install/unix.rst ---
@@ -230,9 +234,55 @@ CouchDB no longer ships with any daemonization scripts.
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
 straightforward; if you have questions, reach out to the CouchDB
--- End diff --

please make the mailing list reference a link, like you've already done for 
runit. It might be worth doing this for IRC  channel too?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80013200
  
--- Diff: src/install/unix.rst ---
@@ -230,9 +234,55 @@ CouchDB no longer ships with any daemonization scripts.
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
 straightforward; if you have questions, reach out to the CouchDB
--- End diff --

Please let's start using contact, which is the correct word when there's 
nothing actually there to "pick up".


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80013525
  
--- Diff: src/install/unix.rst ---
@@ -230,9 +234,55 @@ CouchDB no longer ships with any daemonization scripts.
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
 straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+user mailing list or IRC-channel #couchdb in FreeNode network.
+
+Let's consider configuring of runit on Ubuntu 16.04. The following
+steps should be considered only as an example. Some details can vary
+on different systems and versions of Ubuntu Linux.
+
+Install ruinit::
+
+sudo apt-get install runit
+   
+Create a directory where logs will be written::
+
+sudo mkdir /var/log/couchdb
+sudo chown couchdb:couchdb /var/log/couchdb
+   
+Create directories that will contain runit counfiguration for CouchDB::
+
+sudo mkdir /etc/sv/couchdb
+sudo mkdir /etc/sv/couchdb/log
+   
+Create /etc/sv/couchdb/log/run script::
+
+#!/bin/sh
+exec svlogd -tt /var/log/couchdb
--- End diff --

it might be worth explaining briefly what these commands actually do, 
especially if you're not a runit user.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80014081
  
--- Diff: src/install/unix.rst ---
@@ -230,9 +234,55 @@ CouchDB no longer ships with any daemonization scripts.
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
 straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+user mailing list or IRC-channel #couchdb in FreeNode network.
+
+Let's consider configuring of runit on Ubuntu 16.04. The following
+steps should be considered only as an example. Some details can vary
+on different systems and versions of Ubuntu Linux.
+
+Install ruinit::
+
+sudo apt-get install runit
+   
+Create a directory where logs will be written::
+
+sudo mkdir /var/log/couchdb
+sudo chown couchdb:couchdb /var/log/couchdb
+   
+Create directories that will contain runit counfiguration for CouchDB::
+
+sudo mkdir /etc/sv/couchdb
+sudo mkdir /etc/sv/couchdb/log
+   
+Create /etc/sv/couchdb/log/run script::
+
+#!/bin/sh
+exec svlogd -tt /var/log/couchdb
--- End diff --

Thanks for the updated docs as well as the very specific examples! I'm sure 
this will be very useful.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80013245
  
--- Diff: src/install/unix.rst ---
@@ -230,9 +234,55 @@ CouchDB no longer ships with any daemonization scripts.
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
 straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+user mailing list or IRC-channel #couchdb in FreeNode network.
+
+Let's consider configuring of runit on Ubuntu 16.04. The following
--- End diff --

remove of.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80013188
  
--- Diff: src/install/unix.rst ---
@@ -23,6 +23,10 @@ release are the canonical sources of installation 
information. However, many
 systems have gotchas that you need to be aware of. In addition, 
dependencies
 frequently change as distributions update their archives.
 
+**Hint**: It worth considering to use LXC-, Docker-conteiners, AMI images 
or
--- End diff --

It is worth considering using packaging tools such as LXC, Docker 
containers, AMI images, or similar solutions to configure CouchDB once, and to 
use this configuration consistently across all nodes in a cluster.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80013293
  
--- Diff: src/install/unix.rst ---
@@ -230,9 +234,55 @@ CouchDB no longer ships with any daemonization scripts.
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
 straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+user mailing list or IRC-channel #couchdb in FreeNode network.
+
+Let's consider configuring of runit on Ubuntu 16.04. The following
+steps should be considered only as an example. Some details can vary
--- End diff --

Details will vary by operating system and distribution. Check your system's 
package management tools for specifics.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[dch]

Github user dch commented on a diff in the pull request:

https://github.com/apache/couchdb-documentation/pull/69#discussion_r80013386
  
--- Diff: src/install/unix.rst ---
@@ -230,9 +234,55 @@ CouchDB no longer ships with any daemonization scripts.
 The couchdb team recommends `runit `_ to
 run CouchDB persistently and reliably. Configuration of runit is
 straightforward; if you have questions, reach out to the CouchDB
-user mailing list.
+user mailing list or IRC-channel #couchdb in FreeNode network.
+
+Let's consider configuring of runit on Ubuntu 16.04. The following
+steps should be considered only as an example. Some details can vary
+on different systems and versions of Ubuntu Linux.
+
+Install ruinit::
+
+sudo apt-get install runit
+   
+Create a directory where logs will be written::
+
+sudo mkdir /var/log/couchdb
+sudo chown couchdb:couchdb /var/log/couchdb
+   
+Create directories that will contain runit counfiguration for CouchDB::
--- End diff --

configuration.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation pull request #69: Further improvements of "Installatio...

[afiskon]

GitHub user afiskon opened a pull request:

https://github.com/apache/couchdb-documentation/pull/69

Further improvements of "Installation on Unix-like systems" article

1. Suggest to use containers or AMI's
2. Add an example of configuring runit
3. Some minor changes

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/afiskon/couchdb-documentation master

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/couchdb-documentation/pull/69.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #69


commit 1c209ac45e8f13399672b3c480010b1d2704d37a
Author: Aleksander Alekseev 
Date:   2016-09-22T09:24:09Z

Suggestion to use containers or AMI's added to "Installation on Unix-like 
systems" article

commit a958f1f0e1489dbfff89cb62a47b6d9b9d6e363f
Author: Aleksander Alekseev 
Date:   2016-09-22T09:45:48Z

Add an example of configuring runit to "Installation on Unix-like systems" 
article




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---