Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 1.66 KB

README.md

File metadata and controls

57 lines (34 loc) · 1.66 KB
Raw

Actionables Web

Docker Image

Show actionable items from an Actionables service in the Browser.

Usage

Configuration

Configuration is done using environment variables:

  • PORT: Target port when used with docker-compose (default 8080)
  • ACTIONABLES_URL URL to the actionables collector service, e.g. Redmine Actionables

Run with Docker

docker run --rm -it \
    -p 8080:8080 \
    -e ACTIONABLES_URL="<service url>" \
    mrtux/actionables-web

Run with Docker-Compose (Development)

To run with docker-compose copy .env.template to .env and edit the necessary variables. Then start with:

docker-compose up --build

Please note that this compose file will rebuild the image based on the repository. This is helpful during development and not intended for production use.

When done, please don't forget to remove the deployment with

docker-compose down

Maintainers

Contributing

PRs are welcome!

If possible, please stick to the following guidelines:

  • Keep PRs reasonably small and their scope limited to a feature or module within the code.
  • If a large change is planned, it is best to open a feature request issue first, then link subsequent PRs to this issue, so that the PRs move the code towards the intended feature.

License

MIT © 2020-2023 Stefan Haun and contributors