matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update URLs to the new project github page

Browse Source
This commit is contained in:
Roberto Rosario
2014-05-23 03:13:59 -04:00
parent 935845719f
commit 721567be2b
2 changed files with 63 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
docs/intro/installation.rst
View File

@@ -4,7 +4,7 @@ Installation
Automatic install using included fabfile
----------------------------------------
A Fabric_ file is included to help users not very familiar with Ubuntu_,
A Fabric_ file is included to help users not very familiar with Ubuntu_,
Python_ and Django_ install **Mayan EDMS**, or for system administrators
looking to automate the install whether in a local or remote system.
@@ -16,11 +16,11 @@ installation when executing the fabfile.
* Debian or Ubuntu::
$ cd /tmp && sudo apt-get install -y fabric wget tar gzip && wget https://github.com/rosarior/mayan/raw/master/contrib/fabfile.tar.gz -O - | tar -xvzf - && echo "database_manager_admin_password=<Your MySQL root password>" > ~/.fabricrc && fab -H localhost install
$ cd /tmp && sudo apt-get install -y fabric wget tar gzip && wget https://github.com/mayan-edms/mayan-edms/raw/master/contrib/fabfile.tar.gz -O - | tar -xvzf - && echo "database_manager_admin_password=<Your MySQL root password>" > ~/.fabricrc && fab -H localhost install
* Fedora::
$ cd /tmp && sudo yum install -y fabric wget tar gzip && wget https://github.com/rosarior/mayan/raw/master/contrib/fabfile.tar.gz -O - | tar -xvzf - && echo "database_manager_admin_password=<Your MySQL root password>" > ~/.fabricrc && fab -H localhost install
$ cd /tmp && sudo yum install -y fabric wget tar gzip && wget https://github.com/mayan-edms/mayan-edms/raw/master/contrib/fabfile.tar.gz -O - | tar -xvzf - && echo "database_manager_admin_password=<Your MySQL root password>" > ~/.fabricrc && fab -H localhost install
The ``fabfile`` also supports deploying to more than one server whether
@@ -48,15 +48,15 @@ A sample ``server_config.yaml`` would be as follows::
To install **Mayan EDMS** to these servers the ``fabfile`` should be called in the following manner::
$ fab servers:debian_server install
or::
$ fab servers:ubuntu_server,debian_server install
or::
$ fab servers:all_servers install
Configuration options for the ``fabfile``:
@@ -85,34 +85,34 @@ Local or managed Ubuntu or Debian server
If using a Debian_ or Ubuntu_ based Linux distribution getting the executable requirements is as easy as::
$ sudo apt-get install python-dev gcc tesseract-ocr unpaper python-virtualenv ghostscript libjpeg-dev libpng-dev poppler-utils -y
$ sudo apt-get install python-dev gcc tesseract-ocr unpaper python-virtualenv ghostscript libjpeg-dev libpng-dev poppler-utils -y
To initialize a ``virtualenv`` to deploy the project do::
$ virtualenv --no-site-packages mayan
$ virtualenv --no-site-packages mayan
Download_ and decompress the latest version of **Mayan EDMS**::
$ cd mayan
$ tar -xvzf mayan.tar.gz
$ cd mayan
$ tar -xvzf mayan.tar.gz
Or clone the latest development version straight from github::
$ cd mayan
$ git clone git://github.com/rosarior/mayan.git
$ cd mayan
$ git clone git://github.com/mayan-edms/mayan-edms.git
To install the python dependencies ``easy_install`` can be used, however for easier retrieval a production dependencies file is included, to use it execute::
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
Create the database that will hold the data. Install any corresponding python database drivers. Update the settings.py file with you database settings.
If using the ``MySQL`` database manager, use the following commands::
$ sudo apt-get install libmysqlclient-dev -y
$ pip install MySQL-python
If using ``PostgreSQL``, enter the following::
$ sudo apt-get install libpq-dev -y
@@ -121,7 +121,7 @@ If using ``PostgreSQL``, enter the following::
Populate the database with the project's schema doing::
$ ./manage.py syncdb --migrate --noinput
To test your installation, create a file called settings_local.py with the following content::
DEBUG=True
@@ -151,34 +151,34 @@ Local or managed Fedora server
If using a Fedora_ based Linux distribution getting the executable requirements is as easy as::
$ sudo yum install -y git gcc tesseract unpaper python-virtualenv ghostscript libjpeg-turbo-devel libpng-devel poppler-util python-devel
$ 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::
$ virtualenv --no-site-packages mayan
$ virtualenv --no-site-packages mayan
Download_ and decompress the latest version of **Mayan EDMS**::
$ cd mayan
$ tar -xvzf mayan.tar.gz
$ cd mayan
$ tar -xvzf mayan.tar.gz
Or clone the latest development version straight from github::
$ cd mayan
$ git clone git://github.com/rosarior/mayan.git
$ cd mayan
$ git clone git://github.com/mayan-edms/mayan-edms.git
To install the python dependencies ``easy_install`` can be used, however for easier retrieval a production dependencies file is included, to use it execute::
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
Create the database that will hold the data. Install any corresponding python database drivers. Update the settings.py file with you database settings.
If using the ``MySQL`` database manager, use the following commands::
$ sudo yum install -y mysql-devel
$ pip install MySQL-python
If using ``PostgreSQL``, enter the following::
$ sudo yum install -y postgresql-devel
@@ -187,7 +187,7 @@ If using ``PostgreSQL``, enter the following::
Populate the database with the project's schema doing::
$ ./manage.py syncdb --migrate --noinput
To test your installation, create a file called settings_local.py with the following content::
DEBUG=True
@@ -239,9 +239,9 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
* 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``
@@ -252,7 +252,7 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
$ cd ~/webapps/mayan_app
$ virtualenv --no-site-packages mayan
$ cd mayan
$ git clone git://github.com/rosarior/mayan.git
$ git clone git://github.com/mayan-edms/mayan-edms.git
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
@@ -265,7 +265,7 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'ENGINE': 'django.db.backends.mysql',
'NAME': '<username>_mayan',
'USER': '<username>_mayan',
'PASSWORD': '<database password from step 1>',
@@ -285,7 +285,7 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
8. Create a new app:
* Enter the following:
* Name:* ``mayan_static``
* App category:* ``Symbolic link``
* App type:* ``Symbolic link to static-only app``
@@ -295,33 +295,33 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
* Name: ``mayan_edms``
* Choose a subdomain
* Under ``Site apps:`` enter the following selections:
* 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/<username>/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/<username>/webapps/mayan_app/lib/python2.7 threads=1
change it to::
WSGIDaemonProcess mayan_app processes=2 python-path=/home/<username>/webapps/mayan_app/lib/python2.7 threads=1
@@ -331,7 +331,7 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
apache2/bin/restart
.. _`vendor lock-in`: https://secure.wikimedia.org/wikipedia/en/wiki/Vendor_lock-in
@@ -347,7 +347,7 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
.. _Apache: https://www.apache.org/
.. _Debian: http://www.debian.org/
.. _Ubuntu: http://www.ubuntu.com/
.. _Download: https://github.com/rosarior/mayan/archives/master
.. _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

16
docs/topics/development.rst
View File

@@ -9,8 +9,8 @@ If you have a feature request, suggestion, or bug reports, please open a new
issue on the `GitHub issue tracker`_. To submit patches, please send a pull request on GitHub_. Contributors are credited accordingly on the :ref:`contributors` section.
.. _GitHub: http://github.com/rosarior/mayan/
.. _`GitHub issue tracker`: https://github.com/rosarior/mayan/issues
.. _GitHub: https://github.com/mayan-edms/mayan-edms/
.. _`GitHub issue tracker`: https://github.com/mayan-edms/mayan-edms/issues
.. _scm:
@@ -23,7 +23,7 @@ Source Control
The project is publicly accessible, hosted and can be cloned from **GitHub** using::
$ git clone git://github.com/rosarior/mayan.git
$ git clone git://github.com/mayan-edms/mayan-edms.git
Git branch structure
@@ -46,8 +46,8 @@ To familiarize yourself with the technical details of the project read the :ref:
.. _Git: http://git-scm.org
.. _`Successful Git Branching Model`: http://nvie.com/posts/a-successful-git-branching-model/
.. _git-flow: http://github.com/nvie/gitflow
.. _Downloads: https://github.com/rosarior/mayan/archives/master
.. _git-flow: https://github.com/nvie/gitflow
.. _Downloads: https://github.com/mayan-edms/mayan-edms/archives/master
.. _docs:
@@ -73,7 +73,7 @@ lines to your ``settings_local.py`` file::
'simple': {
'format': '%(levelname)s %(message)s'
},
},
},
'handlers': {
'console':{
'level':'DEBUG',
@@ -86,7 +86,7 @@ lines to your ``settings_local.py`` file::
'handlers':['console'],
'propagate': True,
'level':'DEBUG',
},
},
}
}
@@ -98,7 +98,7 @@ Likewise, to see the debug output of the ``tags`` app, just add the following in
'handlers':['console'],
'propagate': True,
'level':'DEBUG',
},
},
.. _`logging capabilities`: https://docs.djangoproject.com/en/dev/topics/logging