allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brond...@apache.org
Subject [5/7] allura git commit: [#5943] ticket:815 Post-setup docs
Date Mon, 13 Jul 2015 18:15:19 GMT
[#5943] ticket:815 Post-setup docs


Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/ccbd34f6
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/ccbd34f6
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/ccbd34f6

Branch: refs/heads/master
Commit: ccbd34f67544034592d264bd65a70d15c2942941
Parents: 14ed0bd
Author: Igor Bondarenko <jetmind2@gmail.com>
Authored: Thu Jul 9 18:06:13 2015 +0300
Committer: Dave Brondsema <dbrondsema@slashdotmedia.com>
Committed: Mon Jul 13 18:14:37 2015 +0000

----------------------------------------------------------------------
 Allura/docs/getting_started/administration.rst |  1 +
 Allura/docs/getting_started/installation.rst   | 51 ++++++++++++++++++++-
 Allura/docs/getting_started/using.rst          | 41 +++++++++++++++++
 3 files changed, 92 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/allura/blob/ccbd34f6/Allura/docs/getting_started/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/administration.rst b/Allura/docs/getting_started/administration.rst
index 2b49c4e..fc56e5a 100644
--- a/Allura/docs/getting_started/administration.rst
+++ b/Allura/docs/getting_started/administration.rst
@@ -22,6 +22,7 @@ Administration
 .. contents::
    :local:
 
+.. _site-admin-interface:
 
 Site Admin Interface
 ====================

http://git-wip-us.apache.org/repos/asf/allura/blob/ccbd34f6/Allura/docs/getting_started/installation.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/installation.rst b/Allura/docs/getting_started/installation.rst
index 9c08692..30425b4 100644
--- a/Allura/docs/getting_started/installation.rst
+++ b/Allura/docs/getting_started/installation.rst
@@ -24,10 +24,59 @@ Our step-by-step setup instructions are in our INSTALL.markdown file.
 You can r
 
 For a faster and easier setup, see our `Vagrant/VirtualBox installation guide <https://forge-allura.apache.org/p/allura/wiki/Install%20and%20Run%20Allura%20-%20Vagrant/>`_
 
+That's all for the development setup.  For the production setup see :ref:`next section <post-setup-instructions>`.
+
+.. _post-setup-instructions:
+
+Post-setup instructions
+-----------------------
+
+Create project for site-admin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First of all you need to create a project, which will serve as a container for keeping site
administrators (users who will have access to the :ref:`admin interface <site-admin-interface>`).
+
+In order to do that:
+
+- open main page of the site in your browser
+- go to "Projects" neighborhood (:ref:`what-are-neighborhoods`)
+- click "Register a new project" link
+
+By default all admins of "allura" project in "Projects" neighborhood are treated as site
admins. If you want to use different project for that, change `site_admins_project` in :file:`development.ini`.
+
+Change default configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In the :file:`development.ini`:
+
+Change `[handler_console]` section, so that logs go to a file and will include background
tasks info.
+
+.. code-block:: ini
+
+    class = allura.lib.utils.CustomWatchedFileHandler
+    args = ('/path/to/allura.log', 'a')
+
+Add write permissions to the :file:`/path/to/allura.log` for the user you use to run allura
proccess.
+
+Change "secrets".
+
+.. code-block:: ini
+
+    beaker.session.secret = <your-secret-key>
+    beaker.session.validate_key = <yet-another-secret-key>
+
+The first one is used for simple cookies, the latter is used for encrypted cookies.
+
+You can use the following command to generate a good key:
+
+.. code-block:: bash
+
+    ~$ python -c 'import os; l = 20; print "%.2x" * l % tuple(map(ord, os.urandom(l)))'
+
 Configuring Optional Features
 -----------------------------
 
-The `development.ini` file has many options you can explore and configure.  It is geared
towards development, so you will want to review
+The :file:`development.ini` file has many options you can explore and configure.  It is geared
towards development, so you will want to review
 carefully and make changes for production use.
 
 To run SVN and Git services, see the :doc:`scm_host` page.

http://git-wip-us.apache.org/repos/asf/allura/blob/ccbd34f6/Allura/docs/getting_started/using.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/using.rst b/Allura/docs/getting_started/using.rst
index 84d9f93..a1952fa 100644
--- a/Allura/docs/getting_started/using.rst
+++ b/Allura/docs/getting_started/using.rst
@@ -23,6 +23,47 @@ Using Allura
 We don't have much end-user help for Allura yet.  SourceForge projects use Allura,
 though, so their support documentation may be useful to anyone using Allura:
 
+.. _what-are-neighborhoods:
+
+What are neighborhoods?
+-----------------------
+
+You can think of neighborhoods as groups of logically related projects, which all have the
same default options. Allura has two default neighborhoods: "Projects" and "Users". The "Users"
neighborhood is special, it contains a project for every user registered on a site. This user
projects contain a few special tools, e.g. "Profile" and "Statistics".   The "Projects" contains
all other projects.
+
+Each neighborhood has admin interface. You can get there by clicking "Neighborhood administration"
from the home page of the neighborhood or by "Admin" icon in the top toolbar.
+
+This interface allows you to:
+
+- add a new project to the neighborhood
+- change neighborhood's name
+- change neighborhood icon
+- configure redirect from neighborhood's main page to other url
+- specify :ref:`project template <project-templates>` for newly created projects
+- specify project list url (the link will be displayed under neighborhood name in page header)
+- :ref:`anchor tools <anchored-tools>` in the top menu for each project in the neighborhood
+- :ref:`prohibit installation of specific tools <prohibited-tools>` in all projects
of this neighborhood
+
+.. _project-templates:
+
+Project Templates
+^^^^^^^^^^^^^^^^^
+
+TODO
+
+.. _anchored-tools:
+
+Anchored Tools
+^^^^^^^^^^^^^^
+
+TODO
+
+.. _prohibited-tools:
+
+Prohibited Tools
+^^^^^^^^^^^^^^^^
+
+TODO
+
 
 Configuring your project
 ------------------------


Mime
View raw message