Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ItsEcholot/ContainerNursery
Puts Docker Containers to sleep and wakes them back up when they're needed
https://github.com/ItsEcholot/ContainerNursery
containers docker nodejs reverse-proxy
Last synced: 7 days ago
JSON representation
Puts Docker Containers to sleep and wakes them back up when they're needed
- Host: GitHub
- URL: https://github.com/ItsEcholot/ContainerNursery
- Owner: ItsEcholot
- License: mit
- Created: 2021-09-03T17:31:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T10:28:12.000Z (7 months ago)
- Last Synced: 2024-08-01T12:29:15.972Z (3 months ago)
- Topics: containers, docker, nodejs, reverse-proxy
- Language: TypeScript
- Homepage:
- Size: 521 KB
- Stars: 93
- Watchers: 3
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Container Nursery
Written in Node.js, this application acts as a HTTP reverse proxy and stops Docker containers which haven't been accessed recently and starts them again when a new request comes in. ContainerNursery also makes sure there are no more active WebSocket connections before stopping the container.
To improve the user experience a loading page is presented, which automatically reloads when the containers webserver is ready.
The application listens on port `80` by default for HTTP traffic and uses the socket at `/var/run/docker.sock` to connect to the docker daemon.
You can find the changelog in the [CHANGELOG.md](CHANGELOG.md) file.
## Demo
https://user-images.githubusercontent.com/2771251/132314400-817971fd-b364-4c78-9fed-650138960530.mp4
## Installation
I ***heavily*** recommend using another reverse proxy in front of ContainerNursery (for HTTPS, caching, etc.) pointing to your configured listening port (default `80`).
I also recommend running this application in a Docker container. Pull the latest image using:
```docker pull ghcr.io/itsecholot/containernursery:latest```
More information about the available tags and versions can be found on the [GitHub packages page](https://github.com/ItsEcholot/ContainerNursery/pkgs/container/containernursery).
### Example
```bash
docker run \
--name='ContainerNursery' \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /mnt/ContainerNursery/config:/usr/src/app/config \
ghcr.io/itsecholot/containernursery:latest
```
## Configuration
To configure the proxy, edit the `config.yml` file in the `config` directory. The configuration file is automatically reloaded by the application when changes are made.
If no `config.yml` file is found an empty one is automatically created on application start.
The following top-level properties can be configured:
Property | Meaning
---------|--------|
`proxyListeningPort` | The port ContainerNursery should listen on for new http connections. Defaults to `80`.
The virtual hosts the proxy should handle can be configured by adding an object to the `proxyHosts` key.
The following properties are required:
| Property | Meaning |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `domain` | Array or string containing domain(s) to listen for (equals the `host` header) |
| `containerName` | Array or string of which container(s) (by name or id) to start and stop. ContainerNursery can start and stop multiple containers for a single proxy host. The first container in the list (main container) is used to check if the application is ready and reload the loading page. Note however that CN doesn't manage the timing of how the containers are started (database before app etc.). |
| `proxyHost` | Domain / IP of container (use custom Docker bridge networks for dynDNS using the name of the container) |
| `proxyPort` | Port on which the containers webserver listens on |
| `timeoutSeconds` | Seconds after which the container should be stopped. The internal timeout gets reset to this configured value every time a new HTTP request is made, or when the timer runs out while a Websocket connection is still active. |
The following properties are optional:
| Property | Meaning |
|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `displayName` | The name (of the service) that should be displayed on the waiting page |
| `proxyUseHttps` | Boolean indicating if the proxy should use HTTPS to connect to the container. Defaults to `false`. This should only be used if the container only accepts HTTPS requests. It provides no additional security. |
| `stopOnTimeoutIfCpuUsageBelow` | If set, prevents the container from stopping when reaching the configured timeout if the averaged CPU usage (percentage between 0 and 100*core count) of the **main** container (first in the list of container names) is above this value. This is great for containers that should remain running while their doing intensive work even when nobody is doing any http requests, for example handbrake. |
| `proxyUseCustomMethod` | Can be set to a HTTP method (`HEAD`,`GET`, ...) which should be used for the ready check. Some services only respond to certain HTTP methods correctly. |
### Example Configuration
```yaml
proxyListeningPort: 80
proxyHosts:
- domain: handbrake.yourdomain.io
containerName: handbrake
displayName: Handbrake
proxyHost: localhost
proxyPort: 5800
timeoutSeconds: 15
stopOnTimeoutIfCpuUsageBelow: 50
proxyUseCustomMethod: GET
- domain:
- wordpress.yourdomain.io
- wordpress.otherdomain.io
containerName:
- wordpress
- mariadb
proxyHost: wordpress
proxyPort: 3000
proxyUseHttps: true
timeoutSeconds: 1800
```
Now point your existing reverse proxy for the hosts you configured in the previous step to the ContainerNursery IP/Domain Name on port 80.
**Important:** If you use the (otherwise) excellent [NginxProxyManager](https://github.com/jc21/nginx-proxy-manager) ***disable*** the caching for proxy hosts that are routed through ContainerNursery. Because the built-in caching config sadly also caches 404s this will lead to NginxProxyManager caching error messages while your app container is starting up and then refusing to serve the real `.js/.css` file once the startup is complete.
### Example Configuration for [NginxProxyManager](https://github.com/jc21/nginx-proxy-manager)
### Environment Variables
Additionally to the configuration done in the `congif.yml` file, there are a few settings which can only be configured by using environment variables.
| Name | Valid Values | Description |
|----------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `CN_LOG_JSON` | `true` / `false` | If set to `true` all logging is done in a machine readable format (JSON). Defaults to `false`. |
| `CN_LOG_LEVEL` | `debug` / `info` / `warn` / `error` | Sets the minimum log level. Log entries below this importance level won't be printed to the console. Defaults to `info`. |
| `CN_PORT` | `integer` | Sets the port ContainerNursery listens on for new http connections. The `proxyListeningPort` option in the `config.yml` file takes precedence if both are set. Defaults to `80` if no value is set. |