diff options
author | 2020-03-23 09:09:55 -0700 | |
---|---|---|
committer | 2020-03-23 09:09:55 -0700 | |
commit | 7a669751de8bf0f9c0a6c196334c48267a76c649 (patch) | |
tree | 47a99a0115af69c90c20992833a2c1fb665f3556 /README.md | |
parent | Merge pull request #67 from python-discord/update-contrib (diff) |
Document a simple way to run the container from Docker Hub
The current run instructions are geared towards developers. A simpler
way to run snekbox is to start a container with `docker run` via the
image published on Docker Hub.
Resolves #57
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -45,6 +45,18 @@ Communication with snekbox is done over a HTTP REST API. The framework for the H See [`snekapi.py`](snekbox/api/snekapi.py) and [`resources`](snekbox/api/resources) for API documentation. +## Running snekbox + +A Docker image is available on [Docker Hub](https://hub.docker.com/r/pythondiscord/snekbox). A container can be started with the following command, which will also pull the image if it doesn't currently exist locally: + +``` +docker run --ipc=none --privileged -p 8060:8060 pythondiscord/snekbox +``` + +To run it in the background, use the `-d` option. See the documentation on [`docker run`](https://docs.docker.com/engine/reference/commandline/run/) for more information. + +The above command will make the API accessible on the host via `http://localhost:8060/`. Currently there's only one endpoint: `http://localhost:8060/eval`. + ## Development Environment ### Initial Setup |