move installation documentation
- move installation documentation from README.rst to docs/install.rst
This commit is contained in:
		
							parent
							
								
									f96cc5eb14
								
							
						
					
					
						commit
						fdcaef1868
					
				
					 3 changed files with 73 additions and 46 deletions
				
			
		
							
								
								
									
										49
									
								
								README.rst
									
										
									
									
									
								
							
							
						
						
									
										49
									
								
								README.rst
									
										
									
									
									
								
							|  | @ -4,49 +4,8 @@ gvaldap | |||
| 
 | ||||
| This is the GNUViech Admin LDAP administration tool project. | ||||
| 
 | ||||
| Working Environment | ||||
| =================== | ||||
| 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>`_. | ||||
| 
 | ||||
| You have several options in setting up your working environment.  We recommend | ||||
| using virtualenv to separate the dependencies of your project from your | ||||
| system's python environment.  If on Linux or Mac OS X, you can also use | ||||
| virtualenvwrapper to help manage multiple virtualenvs across different | ||||
| projects. | ||||
| 
 | ||||
| Virtualenv Only | ||||
| --------------- | ||||
| 
 | ||||
| First, make sure you are using virtualenv (http://www.virtualenv.org). Once | ||||
| that's installed, create your virtualenv:: | ||||
| 
 | ||||
|     $ virtualenv --distribute gvaldap | ||||
| 
 | ||||
| You will also need to ensure that the virtualenv has the project directory | ||||
| added to the path. Adding the project directory will allow `django-admin.py` to | ||||
| be able to change settings using the `--settings` flag. | ||||
| 
 | ||||
| Virtualenv with virtualenvwrapper | ||||
| ------------------------------------ | ||||
| 
 | ||||
| In Linux and Mac OSX, you can install virtualenvwrapper | ||||
| (http://virtualenvwrapper.readthedocs.org/en/latest/), which will take care of | ||||
| managing your virtual environments and adding the project path to the | ||||
| `site-directory` for you:: | ||||
| 
 | ||||
|     $ mkdir gvaldap | ||||
|     $ mkvirtualenv -a gvaldap gvaldap-dev | ||||
|     $ cd gvaldap && add2virtualenv `pwd` | ||||
| 
 | ||||
| 
 | ||||
| Installation of Dependencies | ||||
| ============================= | ||||
| 
 | ||||
| Depending on where you are installing dependencies: | ||||
| 
 | ||||
| In development:: | ||||
| 
 | ||||
|     $ pip install -r requirements/local.txt | ||||
| 
 | ||||
| For production:: | ||||
| 
 | ||||
|     $ pip install -r requirements.txt | ||||
| Read the :doc:`Installation instructions <install>` to get started locally. | ||||
|  |  | |||
|  | @ -3,6 +3,8 @@ | |||
|    You can adapt this file completely to your liking, but it should at least | ||||
|    contain the root `toctree` directive. | ||||
| 
 | ||||
| .. include:: ../README.rst | ||||
| 
 | ||||
| Welcome to gvaldap's documentation! | ||||
| ==================================== | ||||
| 
 | ||||
|  |  | |||
|  | @ -1,4 +1,70 @@ | |||
| .. index:: installation | ||||
| 
 | ||||
| ======= | ||||
| Install | ||||
| ======= | ||||
| 
 | ||||
| This is where you write how to get a new laptop to run this project. | ||||
| Working Environment | ||||
| =================== | ||||
| 
 | ||||
| You have several options in setting up your working environment.  We recommend | ||||
| using virtualenv to separate the dependencies of your project from your | ||||
| system's python environment.  If on Linux or Mac OS X, you can also use | ||||
| virtualenvwrapper to help manage multiple virtualenvs across different | ||||
| projects. | ||||
| 
 | ||||
| .. index:: virtualenv | ||||
| 
 | ||||
| Virtualenv Only | ||||
| --------------- | ||||
| 
 | ||||
| First, make sure you are using `virtualenv`_. Once that's installed, create | ||||
| your virtualenv: | ||||
| 
 | ||||
| .. code-block:: sh | ||||
| 
 | ||||
|     $ virtualenv --distribute gvaldap | ||||
| 
 | ||||
| .. _virtualenv: https://virtualenv.pypa.io/en/latest/ | ||||
| 
 | ||||
| You will also need to ensure that the virtualenv has the project directory | ||||
| added to the path. Adding the project directory will allow `django-admin.py` to | ||||
| be able to change settings using the `--settings` flag. | ||||
| 
 | ||||
| .. index:: virtualenvwrapper | ||||
| 
 | ||||
| Virtualenv with virtualenvwrapper | ||||
| ------------------------------------ | ||||
| 
 | ||||
| In Linux and Mac OSX, you can install `virtualenvwrapper | ||||
| <http://virtualenvwrapper.readthedocs.org/en/latest/>`_, which will take care | ||||
| of managing your virtual environments and adding the project path to the | ||||
| `site-directory` for you: | ||||
| 
 | ||||
| .. code-block:: sh | ||||
| 
 | ||||
|     $ mkdir gvaldap | ||||
|     $ mkvirtualenv -a gvaldap gvaldap-dev | ||||
|     $ cd gvaldap && add2virtualenv `pwd` | ||||
| 
 | ||||
| 
 | ||||
| .. index:: pip, requirements, dependencies | ||||
| 
 | ||||
| Installation of Dependencies | ||||
| ============================= | ||||
| 
 | ||||
| Depending on where you are installing dependencies: | ||||
| 
 | ||||
| In development: | ||||
| 
 | ||||
| .. code-block:: sh | ||||
| 
 | ||||
|     $ pip install -r requirements/local.txt | ||||
| 
 | ||||
| For production: | ||||
| 
 | ||||
| .. code-block:: sh | ||||
| 
 | ||||
|     $ pip install -r requirements.txt | ||||
| 
 | ||||
| .. index:: celery, worker, ldap queue | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue