mirror of
				https://github.com/ClusterCockpit/cc-docker.git
				synced 2025-11-04 02:55:08 +01:00 
			
		
		
		
	Update README.md
This commit is contained in:
		
							
								
								
									
										26
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										26
									
								
								README.md
									
									
									
									
									
								
							@@ -1,35 +1,15 @@
 | 
				
			|||||||
# cc-docker
 | 
					# cc-docker
 | 
				
			||||||
WARNING: This does not yet work!
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
This is a setup for `docker compose` to deploy a complete ClusterCockpit Application Stack including all external components.
 | 
					This is a setup for `docker compose` to try out a complete ClusterCockpit Application Stack including all external components. This docket setup is intended for demo purposes, but can be easily configured to be used as a development environement for ClusterCockpit.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
At the end it will create containers for:
 | 
					It creates containers for:
 | 
				
			||||||
* mysql
 | 
					* mysql
 | 
				
			||||||
* influxdb
 | 
					* influxdb
 | 
				
			||||||
* php-fpm (including the Symfony application)
 | 
					* php-fpm (including the Symfony application)
 | 
				
			||||||
* phpmyadmin
 | 
					* phpmyadmin
 | 
				
			||||||
* nginx
 | 
					* nginx
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Everything is configured in `.env`.
 | 
					Ports and Passwords are configured in `.env`.
 | 
				
			||||||
 | 
					 | 
				
			||||||
There exist multiple persistent (shared) volumes:
 | 
					 | 
				
			||||||
* `symfony` mapping to `/var/www/symfony` for the ClusterCockpit source tree
 | 
					 | 
				
			||||||
* `sql` mapping to `/var/lib/mysql`
 | 
					 | 
				
			||||||
* `influxdb/data` mapping to `/var/lib/influxdb2`
 | 
					 | 
				
			||||||
* `influxdb/config` mapping to `/etc//influxdb2`
 | 
					 | 
				
			||||||
* `logs/nginx` mapping to `/var/log/nginx`
 | 
					 | 
				
			||||||
* `logs/symfony` mapping to `/var/www/symfony/var/log`
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
The containers are build and started using the command:
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
docker compose up
 | 
					 | 
				
			||||||
```
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Desired modes for the future are:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
* **Demo** Includes everything to try out ClusterCockpit including initial Database Fixtures. No SSL and no reverse Proxy.
 | 
					 | 
				
			||||||
* **Develop** Only includes all external components of ClusterCockpit. A functional PHP environment and the ClusterCockpit source must be maintained on host machine.
 | 
					 | 
				
			||||||
* **Production** Includes everything to run ClusterCockpit in a Production environment including SSL and traefic reverse proxy and container orchestration.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
TODOS (There are probably a lot more!):
 | 
					TODOS (There are probably a lot more!):
 | 
				
			||||||
* Some of the Volume directories need to be created first.
 | 
					* Some of the Volume directories need to be created first.
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user