https://github.com/openfun/etherpad-docker
:whale: Stateless Etherpad Lite docker image
https://github.com/openfun/etherpad-docker
Last synced: about 1 month ago
JSON representation
:whale: Stateless Etherpad Lite docker image
- Host: GitHub
- URL: https://github.com/openfun/etherpad-docker
- Owner: openfun
- License: mit
- Created: 2020-03-24T16:44:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T13:06:51.000Z (over 3 years ago)
- Last Synced: 2025-03-24T00:14:13.191Z (about 1 year ago)
- Language: CSS
- Homepage:
- Size: 605 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Etherpad-lite docker
A stateless Dockerfile for the etherpad-lite application.
## Getting started
To build the image run the following command:
```
$ make build
```
And then you can run a local etherpad instance using postgresql with:
```
$ make run
```
More commands are available, for reference, see:
```
$ make help
```
## Advanced configuration
### Health checks
Our docker image embeds the [lightship](https://github.com/gajus/lightship)
application as an etherpad-lite plugin. It provides health check status
endpoints to a running etherpad instance. The following environment variable
can be injected in the container to configure its behavior:
- `EP_LIGHTSHIP_DETECT_KUBERNETES`: a boolean-like string to choose whether
`lightship` should detect its environment and assign a random port to listen
to while not in k8s environment (default: `false`),
- `EP_LIGHTSHIP_PORT`: the fixed port to listen to
(default: `9002`). Note that if `EP_LIGHTSHIP_DETECT_KUBERNETES` is `true`
and you are running in a non-k8s environment, this setting has no effect.
## Contributing
This project is intended to be community-driven, so please, do not hesitate to
get in touch if you have any question related to our implementation or design
decisions.
We try to raise our code quality standards and expect contributors to follow
the recommandations from our
[handbook](https://openfun.gitbooks.io/handbook/content).
## License
This work is released under the MIT License (see [LICENSE](./LICENSE)).