This PR makes the project to easier to install, use and manage.
Ideally, along with merging this a public Docker image for the project would be published to
Github's container registry, which is a free service for public images.
Here are the improvements:
There's no longer an additional service to manually install or manage. Instead, the the caching service runs as a service container. Because the Docker service on your host will cache the service image, it takes mere seconds to start up.
Instead of writing the cache back into the docker image, the best practice of using a data volume is volumed. Here we use a bind mount to store the cache on the host. This makes it easy to script pruning the cache and demonstrates how the cache can located anywhere on the host.
Installation is now simpler by not defaulting to having authentication set up, instead relying on restricting requests from localhost or the private network for security.
Documentation examples are provided that should work for both the direct-on-host case and the dockerized-build case.
Some details to highlight:
In the README I bumped the version to "3", assuming there would be a major version bump if this is merged.
In the YAML I also added operating_dir: ./ because it was required in my case to work. This seems like a bug that this was required for a default case, but it doesn't hurt and shows off that the option exists.
I put in a fake path to the public Docker image for the project that I recommend is published.
This PR makes the project to easier to install, use and manage.
Ideally, along with merging this a public Docker image for the project would be published to Github's container registry, which is a free service for public images.
Here are the improvements:
Some details to highlight:
operating_dir: ./because it was required in my case to work. This seems like a bug that this was required for a default case, but it doesn't hurt and shows off that the option exists.