Added step to the documentation explaining how to install Mayan EDMS on Webfaction

This commit is contained in:
Roberto Rosario
2011-10-16 08:34:41 -04:00
parent c13e6a5fe9
commit d50b2ef172
2 changed files with 104 additions and 1 deletions

View File

@@ -7,6 +7,8 @@
* Used new multi parameter passing method to improve the usability of
the grant/revoke permission view, thanks to Cezar Jenkins
(https://twitter.com/#!/emperorcezar) for the suggestion
* Added step to the documentation explaining how to install Mayan EDMS
on Webfaction
2011-10-05
----------

View File

@@ -1,7 +1,11 @@
============
Installation
============
**Mayan EDMS** should be installed like any other Django project and preferably using ``virtualenv``.
Local or managed server
-----------------------
**Mayan EDMS** should be deployed_ like any other Django_ project and preferably using virtualenv_.
If using a Debian_ or Ubuntu_ based Linux distribution getting the executable requirements is as easy as::
@@ -43,7 +47,104 @@ Collect the static files of the project into the ``static`` folder for serving v
After that deploy it using the webserver of your preference. If your are using Apache_, a sample site file is included under the contrib directory.
Webfaction
----------
To install **Mayan EDMS** on Webfaction_, follow these steps:
#. Create a new database:
* Enter the following selections:
* Type:* ``Mysql``
* Name:* ``<username>_mayan``
* Encoding:* ``utf-8``
* Anotate the provided password.
#. Create a new app:
* Enter the following in the textbox:
* Name:* ``mayan``
* App category:* ``mod_wsgi``
* App type:* ``mod_wsgi 3.3/Python 2.7``
#. Login via ssh, and execute::
$ easy_install-2.7 virtualenv
$ cd ~/webapps/mayan_app
$ virtualenv --no-site-packages mayan
$ cd mayan
$ git clone git://github.com/rosarior/mayan.git
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
#. Install the Python MySQL database driver::
$ pip install MySQL-python
#. Create a settings_local.py file, and paste into it the following::
$ DATABASES = {
$ 'default': {
$ 'ENGINE': 'django.db.backends.mysql',
$ 'NAME': '<username>_mayan',
$ 'USER': '<username>_mayan',
$ 'PASSWORD': '<database password from step 1>',
$ 'HOST': '',
$ 'PORT': '',
$ }
$ }
#. Create the database schema (during this step two errors will appears about failling to install indexes on ``documents.Document`` and ``documents.DocumentPage`` models, ignore them for now)::
$ ./manage.py syncdb
#. Collect the static files of the apps::
$ ./manage.py collectstatic -l --noinput
#. Create a new app:
* Enter the following:
* Name:* ``mayan_static``
* App category:* ``Symbolic link``
* App type:* ``Symbolic link to static-only app``
* Extra info: ``/home/<username>/webapps/mayan_app/mayan/mayan/static``
#. Create the website:
* Name: ``mayan_edms``
* Choose a subdomain
* Under ``Site apps:`` enter the following selections:
* App #1
* App:* ``mayan_app``
* URL path (ex: '/' or '/blog'):* ``/``
* App #2
* App:* ``mayan_static``
* URL path (ex: '/' or '/blog'):* ``/mayan-static``
#. Edit the file ``~/webapps/mayan_app/apache2/conf/httpd.conf``:
* Disable the ``DirectoryIndex`` line and the ``DocumentRoot`` line
* Add the following line::
WSGIScriptAlias / /home/<username>/webapps/mayan_app/mayan/mayan/wsgi/dispatch.wsgi
.. _Apache: https://www.apache.org/
.. _Debian: http://www.debian.org/
.. _Ubuntu: http://www.ubuntu.com/
.. _Download: https://github.com/rosarior/mayan/archives/master
.. _Webfaction: http://www.webfaction.com
.. _deployed: https://docs.djangoproject.com/en/1.3/howto/deployment/
.. _Django: https://www.djangoproject.com
.. _virtualenv: http://www.virtualenv.org/en/latest/index.html