Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README.md #2

Merged
merged 1 commit into from
Nov 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## inventree-caddy

This repository contains the source code for the `inventree-caddy` Docker image.

The `inventree-caddy` image is based on the [Caddy docker image](https://hub.docker.com/_/caddy), and comes pre-loaded with a configuration file which works "out of the box" with InvenTree.

### InvenTree Setup

To setup InvenTree in docker, refer to our [Docker installation guide](https://docs.inventree.org/en/stable/start/docker_install/).

### Customization

If you wish to change or customize the Caddy configuration, you can mount a custom Caddyfile into the container at `/etc/caddy/Caddyfile`.

Refer to the `Caddyfile` in this repository for a starting point.

### Environment Variables

The following environment variables can be set to customize the behavior of the image (beyond the default Caddy configuration):

| Variable | Description | Default |
| -------- | ----------- | ------- |
| `INVENTREE_SITE_URL` | The *external* URL at which InvenTree is hosted | `inventree.localhost` |
| `INVENTREE_SERVER` | The *internal* URL at which the InvenTree server is hosted (this should point to another docker container) | `http://inventree-server:8000` |

*Note: These environment variables are specified already using the default docker compose file, as part of the regular InvenTree setup.*