mirror of
				https://git.tt-rss.org/fox/ttrss-docker-compose
				synced 2025-11-04 02:04:12 +01:00 
			
		
		
		
	Merge branch 'master' of git.tt-rss.org:fox/ttrss-docker-compose
This commit is contained in:
		
						commit
						469b10c290
					
				
					 2 changed files with 25 additions and 23 deletions
				
			
		
							
								
								
									
										12
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										12
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
					@ -7,12 +7,12 @@ The idea is to provide tt-rss working (and updating) out of the box with minimal
 | 
				
			||||||
 | 
					
 | 
				
			||||||
General outline of the configuration is as follows:
 | 
					General outline of the configuration is as follows:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 - separate containers (frontend: caddy, database: pgsql, app and updater: php/fpm)
 | 
					 - separate containers (frontend: nginx, database: pgsql, app and updater: php/fpm)
 | 
				
			||||||
 - tt-rss updates from git master repository on container restart
 | 
					 - tt-rss updates from git master repository on container restart
 | 
				
			||||||
 - tt-rss source code is stored on a persistent volume so plugins, etc. could be easily added
 | 
					 - tt-rss source code is stored on a persistent volume so plugins, etc. could be easily added
 | 
				
			||||||
 - ``config.php`` is generated if it is missing
 | 
					 - ``config.php`` is generated if it is missing
 | 
				
			||||||
 - database schema is installed automatically if it is missing
 | 
					 - database schema is installed automatically if it is missing
 | 
				
			||||||
 - Caddy has its http port exposed to the outside
 | 
					 - nginx has its http port exposed to the outside
 | 
				
			||||||
 - optional SSL support via Caddy w/ automatic letsencrypt certificates
 | 
					 - optional SSL support via Caddy w/ automatic letsencrypt certificates
 | 
				
			||||||
 - feed updates are handled via update daemon started in a separate container (updater)
 | 
					 - feed updates are handled via update daemon started in a separate container (updater)
 | 
				
			||||||
 - optional backups container which performs tt-rss database backup once a week
 | 
					 - optional backups container which performs tt-rss database backup once a week
 | 
				
			||||||
| 
						 | 
					@ -29,21 +29,23 @@ git clone https://git.tt-rss.org/fox/ttrss-docker-compose.git ttrss-docker && cd
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Copy ``.env-dist`` to ``.env`` and edit any relevant variables you need changed.
 | 
					Copy ``.env-dist`` to ``.env`` and edit any relevant variables you need changed.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* You will likely have to change ``SELF_URL_PATH`` which should equal fully qualified tt-rss
 | 
					You will likely have to change ``SELF_URL_PATH`` which should equal fully qualified tt-rss
 | 
				
			||||||
URL as seen when opening it in your web browser. If this field is set incorrectly, you will
 | 
					URL as seen when opening it in your web browser. If this field is set incorrectly, you will
 | 
				
			||||||
likely see the correct value in the tt-rss fatal error message.
 | 
					likely see the correct value in the tt-rss fatal error message.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Note: ``SELF_URL_PATH`` is updated in generated tt-rss ``config.php`` automatically on container
 | 
					Note: ``SELF_URL_PATH`` is updated in generated tt-rss ``config.php`` automatically on container
 | 
				
			||||||
restart. You don't need to modify ``config.php`` manually for this.
 | 
					restart. You don't need to modify ``config.php`` manually for this.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* By default, container binds to **localhost** port **8280**. If you want the container to be
 | 
					By default, `web` container binds to **localhost** port **8280**. If you want the container to be
 | 
				
			||||||
accessible on the net, without using a reverse proxy sharing same host, you will need to
 | 
					accessible on the net, without using a reverse proxy sharing same host, you will need to
 | 
				
			||||||
remove ``127.0.0.1:`` from ``HTTP_PORT`` variable in ``.env``.
 | 
					remove ``127.0.0.1:`` from ``HTTP_PORT`` variable in ``.env``.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Please don't rename the services inside `docker-compose.yml` unless you know what you're doing. Web container expects application container to be named `app`, if you rename it and it's not accessible via Docker DNS as `http://app` you will run into 502 errors on startup.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#### Build and start the container
 | 
					#### Build and start the container
 | 
				
			||||||
 | 
					
 | 
				
			||||||
```sh
 | 
					```sh
 | 
				
			||||||
docker-compose up --build
 | 
					docker-compose up --build -d
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
See docker-compose documentation for more information and available options.
 | 
					See docker-compose documentation for more information and available options.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -72,15 +72,15 @@ services:
 | 
				
			||||||
      - app
 | 
					      - app
 | 
				
			||||||
    command: /updater.sh
 | 
					    command: /updater.sh
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  web:
 | 
					#  web:
 | 
				
			||||||
    build: ./web
 | 
					#    build: ./web
 | 
				
			||||||
    restart: unless-stopped
 | 
					#    restart: unless-stopped
 | 
				
			||||||
    ports:
 | 
					#    ports:
 | 
				
			||||||
      - ${HTTP_PORT}:2015
 | 
					#      - ${HTTP_PORT}:2015
 | 
				
			||||||
    volumes:
 | 
					#    volumes:
 | 
				
			||||||
      - app:/var/www/html:ro
 | 
					#      - app:/var/www/html:ro
 | 
				
			||||||
    depends_on:
 | 
					#    depends_on:
 | 
				
			||||||
      - app
 | 
					#      - app
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#  web-ssl:
 | 
					#  web-ssl:
 | 
				
			||||||
#    build: ./web-ssl
 | 
					#    build: ./web-ssl
 | 
				
			||||||
| 
						 | 
					@ -97,15 +97,15 @@ services:
 | 
				
			||||||
#    depends_on:
 | 
					#    depends_on:
 | 
				
			||||||
#      - app
 | 
					#      - app
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#  web-nginx:
 | 
					  web-nginx:
 | 
				
			||||||
#    build: ./web-nginx
 | 
					    build: ./web-nginx
 | 
				
			||||||
#    restart: unless-stopped
 | 
					    restart: unless-stopped
 | 
				
			||||||
#    ports:
 | 
					    ports:
 | 
				
			||||||
#      - ${HTTP_PORT}:80
 | 
					      - ${HTTP_PORT}:80
 | 
				
			||||||
#    volumes:
 | 
					    volumes:
 | 
				
			||||||
#      - app:/var/www/html:ro
 | 
					      - app:/var/www/html:ro
 | 
				
			||||||
#    depends_on:
 | 
					    depends_on:
 | 
				
			||||||
#      - app
 | 
					      - app
 | 
				
			||||||
 | 
					
 | 
				
			||||||
volumes:
 | 
					volumes:
 | 
				
			||||||
  db:
 | 
					  db:
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue