aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRahiel Kasim <rahielkasim@gmail.com>2017-06-15 13:47:56 +0200
committerRahiel Kasim <rahielkasim@gmail.com>2017-06-15 13:47:56 +0200
commitc0d5782e785c5abf317b4d3f5779a58f0822ed99 (patch)
treeb59ca0a21911e44eb76c7ae9154894ab34ff27c7
parent7506e568418ad044d566595fe8cf27353848c8e2 (diff)
README: mention adding user to docker group
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9782570..5d6f933 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,21 @@ This is a fork of Yahoo's [open_nsfw][]. The goal is to make the *Not Suitable
for Work* (NSFW) classification model easily accessible through an HTTP API
deployable with Docker.
-[Install Docker][docker] (available in Debian as [docker.io][dpkg]) and build
-the image, this might take a while:
+# Install
+
+First [install Docker][docker] (available in Debian as [docker.io][dpkg]), then
+give the user you want to run the API as permission to use Docker:
+``` shell
+sudo gpasswd -a $USER docker
+```
+You need to logout and login again for this to take effect.
+
+Now build the image, this might take a while:
``` shell
docker build -t open_nsfw https://raw.githubusercontent.com/rahiel/open_nsfw--/master/Dockerfile
```
-Then you can start the API:
+Then you can start the API:
``` shell
docker run -p <port>:8080 open_nsfw
```