diff --git a/docs/intro/installation.rst b/docs/intro/installation.rst index f30a0fa7c2..99aa762589 100644 --- a/docs/intro/installation.rst +++ b/docs/intro/installation.rst @@ -5,7 +5,7 @@ Installation Ubuntu, Debian or Fedora server ------------------------------- -**Mayan EDMS** should be deployed_ like any other Django_ project and preferably using virtualenv_. +**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:: @@ -15,7 +15,7 @@ If using a Fedora_ based Linux distribution get the executable requirements usin $ sudo yum install -y git gcc tesseract unpaper python-virtualenv ghostscript libjpeg-turbo-devel libpng-devel poppler-util python-devel -To initialize a ``virtualenv`` to deploy the project do:: +Initialize a ``virtualenv`` to deploy the project:: $ virtualenv --no-site-packages venv $ source venv/bin/activate @@ -35,13 +35,13 @@ To install the python dependencies ``easy_install`` can be used, however for eas $ cd mayan-edms $ pip install -r requirements.txt -By default Mayan EDMS will create a single file SQLite database which makes is very easy to start using Mayan EDMS. +By default **Mayan EDMS** will create a single file SQLite_ database which makes is very easy to start using **Mayan EDMS**. Populate the database with the project's schema doing:: $ ./manage.py syncdb --migrate --noinput -To test your installation, execute Django’s development server using the ``runserver`` command to launch a local instance of Mayan EDMS:: +To test your installation, execute Django’s development server using the ``runserver`` command to launch a local instance of **Mayan EDMS**:: $ ./manage.py runserver @@ -61,143 +61,21 @@ on the topic https://docs.djangoproject.com/en/1.6/howto/deployment/ Other database managers ----------------------- -If you want to use a database manager other than SQLite3 install any +If you want to use a database manager other than SQLite_ install any corresponding python database drivers and create a settings_local.py file with the corresponding database settings as shown here: https://docs.djangoproject.com/en/1.6/ref/settings/#std:setting-DATABASES -Cloud install -------------- -SaaS provied Appsembler_ has started providing a "1-click install" cloud -offering of **Mayan EDMS**. Go to their website and click on apps to start -your trial period of **Mayan EDMS** on the cloud. - -Webfaction ----------- - -To install **Mayan EDMS** on Webfaction_, follow these steps: - -1. Create a new database: - - * Enter the following selections: - - * Type:* ``Mysql`` - * Name:* ``_mayan`` - * Encoding:* ``utf-8`` - - * Anotate the provided password. - -2. Create a new app: - - * Enter the following in the textbox: - - * Name:* ``mayan_app`` - * App category:* ``mod_wsgi`` - * App type:* ``mod_wsgi 3.3/Python 2.7`` - -3. 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/mayan-edms/mayan-edms.git - $ cd mayan - $ source ../bin/activate - $ pip install -r requirements.txt - -4. Install the Python MySQL database driver:: - - $ pip install MySQL-python - -5. Create a settings_local.py file, and paste into it the following:: - - DATABASES = { - 'default': { - 'ENGINE': 'django.db.backends.mysql', - 'NAME': '_mayan', - 'USER': '_mayan', - 'PASSWORD': '', - 'HOST': '', - 'PORT': '', - } - } - -6. Create the database schema:: - - $ ./manage.py syncdb --migrate --noinput - -7. Collect the static files of the apps:: - - $ ./manage.py collectstatic -l --noinput - -8. 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//webapps/mayan_app/mayan/mayan/static`` - -9. 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`` - -10. Edit the file ``~/webapps/mayan_app/apache2/conf/httpd.conf``: - - * Disable the ``DirectoryIndex`` line and the ``DocumentRoot`` line. - * Add the following line:: - - WSGIScriptAlias / /home//webapps/mayan_app/mayan/mayan/wsgi/dispatch.wsgi - - * Tune your WSGI process to only use 2 workers (as explained here: `Reducing mod_wsgi Memory Consumption`_) - to keep the memory usage under the basic 256MB of RAM provided or upgrade your plan to 512MB, - the line that controls the amount of workers launched is:: - - WSGIDaemonProcess mayan_app processes=5 python-path=/home//webapps/mayan_app/lib/python2.7 threads=1 - - change it to:: - - WSGIDaemonProcess mayan_app processes=2 python-path=/home//webapps/mayan_app/lib/python2.7 threads=1 - - -11. Restart your apache instance: - - * Execute:: - - apache2/bin/restart - - .. _`vendor lock-in`: https://secure.wikimedia.org/wikipedia/en/wiki/Vendor_lock-in .. _Python: http://www.python.org/ .. _Django: http://www.djangoproject.com/ .. _OCR: https://secure.wikimedia.org/wikipedia/en/wiki/Optical_character_recognition .. _`Open source`: https://secure.wikimedia.org/wikipedia/en/wiki/Open_source -.. _DjangoZoom: http://djangozoom.com/ -.. _Youtube: http://bit.ly/mayan-djangozoom .. _Django: http://www.djangoproject.com/ - - .. _Apache: https://www.apache.org/ .. _Debian: http://www.debian.org/ .. _Ubuntu: http://www.ubuntu.com/ .. _Download: https://github.com/mayan-edms/mayan-edms/archives/master -.. _Webfaction: http://www.webfaction.com -.. _deployed: https://docs.djangoproject.com/en/1.3/howto/deployment/ .. _virtualenv: http://www.virtualenv.org/en/latest/index.html -.. _`Reducing mod_wsgi Memory Consumption`: http://docs.webfaction.com/software/mod-wsgi.html#mod-wsgi-reducing-memory-consumption .. _Fedora: http://fedoraproject.org/ -.. _Appsembler: http://appsembler.com/ +.. _SQLite: https://www.sqlite.org/