From 78a11055f3c6d688e50166dcb1aebf617abaa8b2 Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Wed, 4 Feb 2015 00:46:21 +0100 Subject: [PATCH] improve documentation - add better README.rst - improve structure of docs/index.rst - add some words about deployment - remove old implemented ideas and add some new ideas --- README.rst | 13 ++++++++++--- docs/deploy.rst | 11 +++++++++-- docs/ideas.rst | 21 +++++---------------- docs/index.rst | 14 ++++++++------ 4 files changed, 32 insertions(+), 27 deletions(-) diff --git a/README.rst b/README.rst index 8aad2f0..3d7e316 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,17 @@ -============= gnuviechadmin -============= +------------- -Customer center for gnuviech servers. +This is the GNUViech Admin Customer Center for gnuviech servers. + +GNUViech Admin is a suite of tools for server management used for hosting +customer management at `Jan Dittberner IT-Consulting & -Solutions +`_. Gnuviechadmin is based on Django_ and Celery_ .. _Django: https://djangoproject.com/ .. _Celery: http://www.celeryproject.com/ + +The project page for gnuviechadmin is at http://dev.gnuviech-server.de/gva. If +you find some problem or have some feature suggestions you can post a new +ticket in our issue tracker on the project page. diff --git a/docs/deploy.rst b/docs/deploy.rst index 1e642c7..7b5f4fa 100644 --- a/docs/deploy.rst +++ b/docs/deploy.rst @@ -1,4 +1,11 @@ Deploy -======== +====== -This is where you describe how the project is deployed in production. +The production deployment for gnuviechadmin is performed using saltstack and +consists of the following steps: + +* installation of native dependencies +* setup of a virtualenv +* installation of gnuviechadmin production dependencies inside the virtualenv +* setup of uwsgi application for the web interface +* setup of nginx with certificates and UWSGI support diff --git a/docs/ideas.rst b/docs/ideas.rst index 8f5a9b0..46a7721 100644 --- a/docs/ideas.rst +++ b/docs/ideas.rst @@ -1,19 +1,8 @@ Development ideas and planned features ====================================== -* password reset for - - - OS users - - mailboxes - -* add ssh key management for sftp users - -* link to phpmyadmin and phppgadmin - -* link to webmail - -* list mail domains - -* CRUD for mailboxes - -* CRUD for mail addresses +* add pure redirect websites +* add management for rewrite rules +* add accounts without SFTP (for pure mail hosting) +* allow generation of Key and CSR, add upload of certificates for HTTPS sites +* add XMPP management diff --git a/docs/index.rst b/docs/index.rst index a151e54..a4707d9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,20 +3,22 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +========================================= +Welcome to gnuviechadmin's documentation! +========================================= + .. include:: ../README.rst License -======= +------- gnuviechadmin is licensed under the terms of the MIT license: .. include:: ../LICENSE.txt :literal: -Welcome to gnuviechadmin's documentation! -========================================= - -Contents: +Contents +-------- .. toctree:: :maxdepth: 2 @@ -30,7 +32,7 @@ Contents: Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex`