Use non-root user in Dockerfile (#15)

Author: Neel Kamath

.gitignore

@@ -2,4 +2,5 @@ s2v_old/
 .idea/
 redoc-static.html
 .pytest_cache/
-venv/
+venv/
+__pycache__/

.gitlab-ci.yml

@@ -29,9 +29,7 @@ test-server:
 test-spec:
   stage: test
   image: node
-  script:
-    - npm i -g @stoplight/spectral
-    - spectral lint docs/openapi.yaml
+  script: npx @stoplight/spectral lint docs/openapi.yaml
 
 build-image:
   stage: build
@@ -52,9 +50,7 @@ build-image:
 build-docs:
   stage: build
   image: node
-  script:
-    - npm i -g redoc-cli
-    - redoc-cli bundle docs/openapi.yaml --title 'spaCy'
+  script: npx redoc-cli bundle docs/openapi.yaml --title 'spaCy Server'
   artifacts:
     paths: [redoc-static.html]
   only: [master]

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7
+FROM python:3.8
 WORKDIR /app
 ENV PYTHONUNBUFFERED 1
 COPY requirements.txt .
@@ -8,4 +8,6 @@ COPY s2v_old/ s2v_old/
 EXPOSE 8000
 HEALTHCHECK --timeout=2s --start-period=2s --retries=1 \
     CMD curl -f http://localhost:8000/health_check
+RUN useradd user
+USER user
 CMD ["uvicorn", "main:app", "--host", "0.0.0.0"]

README.md

@@ -10,7 +10,7 @@ This project provides industrial-strength NLP via [spaCy](https://spacy.io/) and
 
 Install [Docker](https://hub.docker.com/search/?type=edition&offering=community).
 
-The container `EXPOSE`s port `8080`. To serve at `http://localhost:8080`, run `docker run --rm -p 8080:8080 neelkamath/spacy-server`.
+The container `EXPOSE`s port `8000`. To serve at `http://localhost:8000`, run `docker run --rm -p 8000:8000 neelkamath/spacy-server`.
 
 You can find specific versions on the [Docker Hub repository](https://hub.docker.com/repository/docker/neelkamath/spacy-server/tags?page=1).
 

docker-compose.test.yml

@@ -1,4 +1,4 @@
 version: '3.7'
 services:
   app:
-    command: sh setup.sh 'pytest'
+    command: sh setup.sh pytest

docker-compose.yml

@@ -1,10 +1,11 @@
 # It is not possible to use a Docker volume to cache the dependencies because subsequent usage of the volume
 # occasionally gets corrupted for an unknown reason. Hence, a virtual environment is to be used instead. It is known
 # that virtual environments aren't needed in Docker because isolation is already provided; we use it as a cache instead.
+
 version: '3.7'
 services:
   app:
-    image: python:3.7
+    image: python:3.8
     working_dir: /app
     volumes:
       - type: bind

docs/CONTRIBUTING.md

@@ -6,13 +6,9 @@ If you're forking the repo to develop the project as your own and not just to se
 
 1. Install [Docker](https://hub.docker.com/search/?type=edition&offering=community).
 1. If you are generating documentation or testing the spec, install [node.js](https://nodejs.org/en/download/).
-1. If you are generating documentation, run `npm i -g redoc-cli`.
-1. If you are testing the spec, run `npm i -g @stoplight/spectral`.
 1. Clone the repository using one of the following methods.
     - SSH: `git clone [email protected]:neelkamath/spacy-server.git`
     - HTTPS: `git clone https://github.com/neelkamath/spacy-server.git`
-1. `cd spacy-server`
-1. Download the [pretrained vectors](https://github.com/explosion/sense2vec/releases/download/v1.0.0/s2v_reddit_2015_md.tar.gz).
-1. Extract the pretrained vectors. You should get a directory named `s2v_old`.
+1. Download the [pretrained vectors](https://github.com/explosion/sense2vec/releases/download/v1.0.0/s2v_reddit_2015_md.tar.gz). After extracting them into the project's directory, uou should get a directory named `s2v_old`.
 
 ## [Developing](developing.md)

docs/developing.md

@@ -5,15 +5,16 @@
 ### Development
 
 ```
-docker-compose up --build
+docker-compose -p dev up --build
 ```
 
 The server will be running on `http://localhost:8000`, and has automatic reload enabled.
 
 ### Testing
 
 ```
-docker-compose -f docker-compose.yml -f docker-compose.test.yml up --build --abort-on-container-exit --exit-code-from app
+docker-compose -p test -f docker-compose.yml -f docker-compose.test.yml \
+    up --build --abort-on-container-exit --exit-code-from app
 ```
 
 ### Production
@@ -31,15 +32,15 @@ The container `EXPOSE`s port `8000`. To serve at `http://localhost:8080`, run `d
 ### Testing
 
 ```
-spectral lint docs/openapi.yaml
+npx @stoplight/spectral lint docs/openapi.yaml
 ```
 
 ## Documentation
 
 ### Developing
 
 ``` 
-redoc-cli serve docs/openapi.yaml -w
+npx redoc-cli serve docs/openapi.yaml -w
 ```
 
 Open `http://127.0.0.1:8080` in your browser. 
@@ -49,7 +50,7 @@ The documentation will automatically rebuild whenever you save a change to `docs
 ### Production
 
 ``` 
-redoc-cli bundle docs/openapi.yaml -o redoc-static.html --title 'spaCy Server'
+npx redoc-cli bundle docs/openapi.yaml -o redoc-static.html --title 'spaCy Server'
 ```
 
 Open `redoc-static.html` in your browser.

setup.sh

@@ -5,4 +5,4 @@
 python -m venv venv
 . venv/bin/activate
 pip install -r requirements.txt
-$1
+$1