Docker Hub Image

.github/workflows/docker-hub.yml

@@ -0,0 +1,102 @@
+name: Docker Image CI
+
+on:
+  release:
+    types: [published]
+  push:
+    branches:
+      - '*'
+    tags:
+      - '*'
+
+jobs:
+  version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+    - id: version
+      name: Get and check version
+      run: |
+        export VERSION=$(echo $GITHUB_REF | sed -re 's/^.*\/([0-9a-zA-Z._-]+)$/\1/')
+        echo "::set-output name=version::$VERSION"
+        echo version is $VERSION
+  build:
+    runs-on: ubuntu-latest
+    needs:
+     - version
+    env:
+      DOCKER_USER: ${{ secrets.DOCKER_USER }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+    - name: Build
+      uses: docker/build-push-action@v2
+      with:
+        context: .
+        file: ./docker/Dockerfile
+        tags: ${{ env.DOCKER_USER }}/armadietto:${{ needs.version.outputs.version }}
+        outputs: type=docker,dest=/tmp/docker.tar
+    - name: Upload artifact
+      uses: actions/upload-artifact@v2
+      with:
+        name: docker
+        path: /tmp/docker.tar
+  sec_test:
+    runs-on: ubuntu-latest
+    needs:
+      - version
+      - build
+    env:
+      DOCKER_USER: ${{ secrets.DOCKER_USER }}
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v2
+      with:
+        name: docker
+        path: /tmp
+    - name: Load docker image
+      run: docker load --input /tmp/docker.tar
+    - name: Run security tests
+      continue-on-error: true
+      run: |
+        docker run --rm  -v /var/run/docker.sock:/var/run/docker.sock aquasec/trivy image --exit-code 1 $DOCKER_USER/armadietto:${{ needs.version.outputs.version }}
+  #e2e_test:
+  #  runs-on: ubuntu-latest
+  #  needs:
+  #    - version
+  #    - build
+  #  steps:
+  #  - uses: actions/checkout@v2
+  #  - name: Download artifacts
+  #    uses: actions/download-artifact@v2
+  #    with:
+  #      name: docker
+  #      path: /tmp
+  #  - name: Load docker image
+  #    run: docker load --input /tmp/docker.tar
+  publish:
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    needs:
+      - version
+      - sec_test
+      #- e2e_test
+    env:
+      DOCKER_USER: ${{ secrets.DOCKER_USER }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v2
+      with:
+        name: docker
+        path: /tmp
+    - name: Load docker image
+      run: docker load --input /tmp/docker.tar
+    - name: Publish Docker image
+      run: |
+        docker login -u $DOCKER_USER -p $DOCKER_TOKEN
+        docker push $DOCKER_USER/armadietto:${{ needs.version.outputs.version }}
+        docker tag $DOCKER_USER/armadietto:${{ needs.version.outputs.version }} $DOCKER_USER/armadietto
+        docker push $DOCKER_USER/armadietto

docker/Dockerfile

@@ -0,0 +1,63 @@
+FROM alpine:latest as build
+
+ARG PKG_MANAGER="npm"
+ARG INSTALL_COMMAND="npm ci --production"
+
+RUN mkdir /opt/armadietto
+WORKDIR /opt/armadietto
+
+RUN apk add nodejs $PKG_MANAGER
+
+COPY package.json ./
+COPY package-lock.json ./
+
+RUN $INSTALL_COMMAND
+
+FROM alpine:latest
+
+LABEL description="Armadietto Node.js web service (a remoteStorage server)"
+
+ARG CONFIG_PATH_STORAGE="/usr/share/armadietto"
+ARG CONFIG_PATH_LOGS="/opt/armadietto/logs"
+ARG PROJECT_NAME="armadietto"
+ARG PORT="8000"
+ARG USER="armadietto"
+
+ENV NODE_ENV=production
+ENV PROJECT_NAME=$PROJECT_NAME
+ENV PORT=$PORT
+
+RUN mkdir /opt/armadietto
+WORKDIR /opt/armadietto
+
+
+RUN apk add nodejs
+
+RUN adduser -u 6582 -HD $PROJECT_NAME
+
+RUN mkdir -m 0700 $CONFIG_PATH_STORAGE
+RUN mkdir -m 0700 $CONFIG_PATH_LOGS
+RUN chown $PROJECT_NAME $CONFIG_PATH_STORAGE
+RUN chown $PROJECT_NAME $CONFIG_PATH_LOGS
+
+COPY --from=build /opt/armadietto/node_modules/ node_modules/
+COPY package.json ./
+COPY README.md ./
+COPY lib/ lib/
+COPY bin/ bin/
+
+# Ensure bin file (esp the bang line) has unix eol
+RUN dos2unix bin/armadietto.js
+
+RUN ln -s /opt/armadietto/bin/armadietto.js /usr/local/bin/armadietto
+
+COPY docker/config.json /etc/armadietto/conf
+
+VOLUME $CONFIG_PATH_STORAGE
+VOLUME $CONFIG_PATH_LOGS
+EXPOSE $PORT
+USER $PROJECT_NAME
+
+CMD armadietto -c /etc/armadietto/conf
+
+HEALTHCHECK --start-period=10s CMD wget -q -O /dev/null http://127.0.0.1:$PORT/

docker/README.md

@@ -0,0 +1,98 @@
+# armadietto [![Build Status](https://secure.travis-ci.org/remotestorage/armadietto.svg)](http://travis-ci.org/remotestorage/armadietto) [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)
+
+> ### WARNING
+> Please do not consider `armadietto` production ready, this project is still
+> considered experimental.  As with any alpha-stage storage technology, you
+> MUST expect that it will eat your data and take precautions against this. You
+> SHOULD expect that its APIs and storage schemas will change before it is
+> labelled stable.
+
+## What is this?
+
+Armadietto is a [RemoteStorage](https://remotestorage.io) server written for Node.js.
+
+This is a complete rewrite of [reStore](https://github.com/jcoglan/restore).
+
+It is also available as the
+[armadietto](https://www.npmjs.com/package/armadietto) NPM package.
+
+## Usage
+
+```
+docker run -d -p 8000:8000 remotestorage/armadietto:latest
+```
+
+### Configuration
+
+The default configuration file for armadietto can be found within the docker
+container in `/etc/armadietto/conf` and contains the following
+configuration:
+
+```json
+{
+  "allow_signup": true,
+  "storage_path": "/usr/share/armadietto",
+  "cache_views": true,
+  "http": {
+    "host": "0.0.0.0",
+    "port": 8000
+  },
+  "https": {
+    "enable": false,
+    "force": false,
+    "port": 4443,
+    "cert": "/etc/letsencrypt/live/example.com/cert.pem",
+    "key": "/etc/letsencrypt/live/example.com/privkey.pem"
+  },
+  "logging": {
+	  "log_dir": "logs",
+	  "stdout": ["info"],
+	  "log_files": ["error"]
+  },
+  "basePath": ""
+}
+```
+
+A custom configuration file can be used by mounting it in the container
+
+```
+docker run -d -v /my/custom/armadietto.conf.json:/etc/armadietto/conf:ro -p 8000:8000 remotestorage/armadietto:latest
+```
+
+A suitable data directory should also be mounted in the container to
+ensure data is persisted.
+
+```
+docker run -d -v /data/armadietto:/usr/share/armadietto -p 8000:8000 remotestorage/armadietto:latest
+```
+
+*Note:* The data and log folders and their contents must be writable and
+readable by the container user, which is by default the `armadietto` user
+(UID 6582).
+
+### Behind a Proxy
+
+To use armadietto behind a proxy, ensure the `X-Forwarded-Host` and
+`X-Forwareded-Proto` headers are passed to armadietto to ensure it uses the
+correct address. For more information, see the
+[notes](https://github.com/remotestorage/armadietto/tree/master/notes)
+folder in the armadietto git repository.
+
+## Development
+
+The armadietto docker image is built using the
+[armadietto](https://github.com/remotestorage/armadietto) git repository
+and the [`docker/Dockerfile`](https://github.com/remotestorage/armadietto/blob/master/docker/Dockerfile)
+[Dockerfile](https://docs.docker.com/engine/reference/builder/). To build
+the image yourself, clone the git repository and use the
+[`docker build`](https://docs.docker.com/engine/reference/commandline/build/) command.
+
+```
+git clone https://github.com/remotestorage/armadietto
+cd armadietto
+docker build -t remotestorage/armadietto -f docker/Dockerfile .
+```
+
+Further information about the development of armadietto can be found in the
+[DEVELOPMENT.md](https://github.com/remotestorage/armadietto/blob/master/DEVELOPMENT.md)
+file in git repository.

docker/config.json

@@ -0,0 +1,23 @@
+{
+  "allow_signup": true,
+  "storage_path": "/usr/share/armadietto",
+  "cache_views": true,
+  "http": {
+    "host": "0.0.0.0",
+    "port": 8000
+  },
+  "https": {
+    "enable": false,
+    "force": false,
+    "port": 4443,
+    "cert": "/etc/letsencrypt/live/example.com/cert.pem",
+    "key": "/etc/letsencrypt/live/example.com/privkey.pem"
+  },
+  "logging": {
+	  "log_dir": "logs",
+	  "stdout": ["info"],
+	  "log_files": ["error"]
+  },
+  "basePath": ""
+}
+