forked from ungleich-public/cdist
		
	documentation pointers
Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
This commit is contained in:
		
					parent
					
						
							
								7550f4de3e
							
						
					
				
			
			
				commit
				
					
						b512a76db9
					
				
			
		
					 2 changed files with 36 additions and 30 deletions
				
			
		
							
								
								
									
										5
									
								
								docs/web/cdist/documentation.mdwn
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								docs/web/cdist/documentation.mdwn
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,5 @@ | ||||||
|  | 
 | ||||||
|  | * [Latest documentation](man/latest) | ||||||
|  | * [All versions](man) | ||||||
|  | 
 | ||||||
|  | [[!tag cdist unix]] | ||||||
|  | @ -1,3 +1,4 @@ | ||||||
|  | [[!meta title="How to install cdist"]] | ||||||
| [[!toc levels=3]] | [[!toc levels=3]] | ||||||
| 
 | 
 | ||||||
| ## Requirements | ## Requirements | ||||||
|  | @ -7,7 +8,7 @@ | ||||||
| This is the machine you use to configure the target hosts. | This is the machine you use to configure the target hosts. | ||||||
| 
 | 
 | ||||||
|  * /bin/sh: A posix like shell (for instance bash, dash, zsh) |  * /bin/sh: A posix like shell (for instance bash, dash, zsh) | ||||||
|  * Python (>= 3.2 required) |  * Python >= 3.2 | ||||||
|  * SSH client |  * SSH client | ||||||
|  * Asciidoc (for building the manpages) |  * Asciidoc (for building the manpages) | ||||||
| 
 | 
 | ||||||
|  | @ -16,10 +17,14 @@ This is the machine you use to configure the target hosts. | ||||||
|  * /bin/sh: A posix like shell (for instance bash, dash, zsh) |  * /bin/sh: A posix like shell (for instance bash, dash, zsh) | ||||||
|  * SSH server |  * SSH server | ||||||
| 
 | 
 | ||||||
| ## Python Installation | ## Requirement Installation: Python >= 3.2 | ||||||
| 
 | 
 | ||||||
| Ensure you have Python 3.2 installed on the machine you use to **deploy to the targets** | Ensure you have at least Python 3.2 or newer installed on  | ||||||
| (the ***source host***). | the **source host**. | ||||||
|  | You can check this by running **python -V**: | ||||||
|  | 
 | ||||||
|  |     % python -V | ||||||
|  |     Python 3.3.0 | ||||||
| 
 | 
 | ||||||
| ### Archlinux | ### Archlinux | ||||||
| 
 | 
 | ||||||
|  | @ -32,7 +37,7 @@ You can install it using | ||||||
| 
 | 
 | ||||||
| See the "From source" section | See the "From source" section | ||||||
| 
 | 
 | ||||||
| #### Debian | ### Debian | ||||||
| 
 | 
 | ||||||
| For Debian **wheezy** or newer: | For Debian **wheezy** or newer: | ||||||
| 
 | 
 | ||||||
|  | @ -97,9 +102,13 @@ You can choose between Homebrew and Macports, either way works: | ||||||
|     port install python32 |     port install python32 | ||||||
|     ln -s /opt/local/bin/python3.2 /opt/local/bin/python3 |     ln -s /opt/local/bin/python3.2 /opt/local/bin/python3 | ||||||
| 
 | 
 | ||||||
|  | ### Redhat | ||||||
|  | 
 | ||||||
|  | See the "From source" section | ||||||
|  | 
 | ||||||
| ### From Source | ### From Source | ||||||
| 
 | 
 | ||||||
| For those operating systems not yet support Python 3.2: | For those operating systems not yet supporting Python 3.2: | ||||||
| 
 | 
 | ||||||
|     pyversion=3.2.3 |     pyversion=3.2.3 | ||||||
|     wget http://www.python.org/ftp/python/$pyversion/Python-${pyversion}.tar.bz2 |     wget http://www.python.org/ftp/python/$pyversion/Python-${pyversion}.tar.bz2 | ||||||
|  | @ -109,43 +118,35 @@ For those operating systems not yet support Python 3.2: | ||||||
|     make |     make | ||||||
|     sudo make install |     sudo make install | ||||||
| 
 | 
 | ||||||
| This installs python 3.2 to /usr/local/bin. Ensure this directory is in | This installs python 3.2 to /usr/local/bin.  | ||||||
| your PATH environment variable. | Ensure this directory is in your PATH environment variable. | ||||||
| 
 |  | ||||||
| 
 | 
 | ||||||
| ## Install cdist | ## Install cdist | ||||||
| 
 | 
 | ||||||
| You can clone cdist from git, which gives you the advantage of having | You can install cdist either from git or as a python package. | ||||||
| a version control in place for development of your own stuff as well. | 
 | ||||||
|  | ### From git | ||||||
|  | 
 | ||||||
|  | Cloning cdist from git gives you the advantage of having | ||||||
|  | a version control in place for development of your own stuff | ||||||
|  | immediately. | ||||||
|  | 
 | ||||||
| To install cdist, execute the following commands: | To install cdist, execute the following commands: | ||||||
| 
 | 
 | ||||||
|     git clone git://git.schottelius.org/cdist |     git clone git://git.schottelius.org/cdist | ||||||
|     cd cdist |     cd cdist | ||||||
|     export PATH=$PATH:$(pwd -P)/bin |     export PATH=$PATH:$(pwd -P)/bin | ||||||
| 
 | 
 | ||||||
|     # If you want the manpages | If you want to build and use the manpages, run: | ||||||
|  | 
 | ||||||
|     ./build man |     ./build man | ||||||
|     export MANPATH=$MANPATH:$(pwd -P)/doc/man |     export MANPATH=$MANPATH:$(pwd -P)/doc/man | ||||||
| 
 | 
 | ||||||
|  | #### Available versions in git | ||||||
| 
 | 
 | ||||||
| ### Available versions |  * The active development takes place in the **master** branch | ||||||
| 
 |  * The current stable version can be found in the **2.0** branch | ||||||
| There are at least the following branches available: |  * The upcoming stable version can be found in the **2.1** branch | ||||||
| 
 |  | ||||||
|  * Development: master |  | ||||||
|  * 2.0: Current stable branch |  | ||||||
|  * 2.1: Currently experimental - the next stable branch |  | ||||||
| 
 |  | ||||||
| Old versions: |  | ||||||
| 
 |  | ||||||
|  * 1.7: Bugfixes, cleanups, new type and explorer rename |  | ||||||
|  * 1.6: New types, cleaned up \_\_package* types, internal cleanup |  | ||||||
|  * 1.5: Focus on object orientation instead of global stage orientation |  | ||||||
|  * 1.4: Support for redefiniton of objects (if equal) |  | ||||||
|  * 1.3: Support for local and remote code execution (current stable) |  | ||||||
|  * 1.2: Dependencies supported |  | ||||||
|  * 1.1: \_\_file to \_\_file, \_\_directory, \_\_link migration |  | ||||||
|  * 1.0: First official release |  | ||||||
| 
 | 
 | ||||||
| Other branches may be available for features or bugfixes, but they | Other branches may be available for features or bugfixes, but they | ||||||
| may vanish at any point. To select a specific branch use | may vanish at any point. To select a specific branch use | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue