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
This commit is contained in:
parent
f154a2efac
commit
78a11055f3
4 changed files with 32 additions and 27 deletions
13
README.rst
13
README.rst
|
@ -1,10 +1,17 @@
|
||||||
=============
|
|
||||||
gnuviechadmin
|
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
|
||||||
|
<http://www.gnuviech-server.de>`_.
|
||||||
|
|
||||||
Gnuviechadmin is based on Django_ and Celery_
|
Gnuviechadmin is based on Django_ and Celery_
|
||||||
|
|
||||||
.. _Django: https://djangoproject.com/
|
.. _Django: https://djangoproject.com/
|
||||||
.. _Celery: http://www.celeryproject.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.
|
||||||
|
|
|
@ -1,4 +1,11 @@
|
||||||
Deploy
|
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
|
||||||
|
|
|
@ -1,19 +1,8 @@
|
||||||
Development ideas and planned features
|
Development ideas and planned features
|
||||||
======================================
|
======================================
|
||||||
|
|
||||||
* password reset for
|
* add pure redirect websites
|
||||||
|
* add management for rewrite rules
|
||||||
- OS users
|
* add accounts without SFTP (for pure mail hosting)
|
||||||
- mailboxes
|
* allow generation of Key and CSR, add upload of certificates for HTTPS sites
|
||||||
|
* add XMPP management
|
||||||
* 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
|
|
||||||
|
|
|
@ -3,20 +3,22 @@
|
||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
=========================================
|
||||||
|
Welcome to gnuviechadmin's documentation!
|
||||||
|
=========================================
|
||||||
|
|
||||||
.. include:: ../README.rst
|
.. include:: ../README.rst
|
||||||
|
|
||||||
License
|
License
|
||||||
=======
|
-------
|
||||||
|
|
||||||
gnuviechadmin is licensed under the terms of the MIT license:
|
gnuviechadmin is licensed under the terms of the MIT license:
|
||||||
|
|
||||||
.. include:: ../LICENSE.txt
|
.. include:: ../LICENSE.txt
|
||||||
:literal:
|
:literal:
|
||||||
|
|
||||||
Welcome to gnuviechadmin's documentation!
|
Contents
|
||||||
=========================================
|
--------
|
||||||
|
|
||||||
Contents:
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
@ -30,7 +32,7 @@ Contents:
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
------------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
|
|
Loading…
Reference in a new issue