Changeset - c819a1e9103b
[Not reviewed]
default
0 2 0
Mads Kiilerich (mads) - 6 years ago 2020-08-24 15:02:16
mads@kiilerich.com
Grafted from: 77d70ff0aa37
docs: clarify the idea of best practice of installing in srv

This was introduced in 03bbd33bc084 as it seems like the best location based on
Filesystem Hierarchy Standard.
2 files changed with 9 insertions and 0 deletions:
0 comments (0 inline, 0 general)
docs/installation.rst
Show inline comments
 
@@ -81,12 +81,16 @@ problematic when upgrading the system or
 
An additional benefit of virtualenv is that it doesn't require root privileges.
 

	
 
- Don't install as root - install as a dedicated user like ``kallithea``.
 
  If necessary, create the top directory for the virtualenv (like
 
  ``/srv/kallithea/venv``) as root and assign ownership to the user.
 

	
 
  Make a parent folder for the virtualenv (and perhaps also Kallithea
 
  configuration and data files) such as ``/srv/kallithea``. Create the
 
  directory as root if necessary and grant ownership to the ``kallithea`` user.
 

	
 
- Create a new virtual environment, for example in ``/srv/kallithea/venv``,
 
  specifying the right Python binary::
 

	
 
    python3 -m venv /srv/kallithea/venv
 

	
 
- Activate the virtualenv in your current shell session and make sure the
docs/overview.rst
Show inline comments
 
@@ -71,12 +71,17 @@ Kallithea can be installed in many diffe
 
  the ``.ini`` file, as ``kallithea.db``.
 

	
 
- A location for the repositories that are hosted by this Kallithea instance.
 
  This will have to be writable by the running Kallithea service. The path to
 
  this location will be configured in the database.
 

	
 
For production setups, one recommendation is to use ``/srv/kallithea`` for the
 
``.ini`` and ``data``, place the virtualenv in ``venv``, and use a Kallithea
 
clone in ``kallithea``. Create a ``kallithea`` user, let it own
 
``/srv/kallithea``, and run as that user when installing.
 

	
 
For simple setups, it is fine to just use something like a ``kallithea`` user
 
with home in ``/home/kallithea`` and place everything there.
 

	
 
For experiments, it might be convenient to run everything as yourself and work
 
inside a clone of Kallithea, with the ``.ini`` and SQLite database in the root
 
of the clone, and a virtualenv in ``venv``.
0 comments (0 inline, 0 general)