Skip to content

Commit

Permalink
re-enabled docks builds, updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shukriadams committed May 13, 2021
1 parent cfa0a0e commit 5c8787f
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 45 deletions.
47 changes: 24 additions & 23 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,31 @@ on:
tags:
- '*'
jobs:
# docker-armhf:
# runs-on: self-hosted
# steps:
# # clean before building
# - name: cleanup
# run: |
# echo "Cleaning up previous run"
# sudo rm -rf "${{ github.workspace }}"
# - uses: actions/checkout@v1
# - name: builds docker container and pushes to docker hub
# run: cd build && sh ./build.sh --dockerpush --smoketest --arc -arm
# env:
# DOCKER_PASS: ${{ secrets.DOCKER_PASS }}
# DOCKER_USER: ${{ secrets.DOCKER_USER }}

docker-armhf:
runs-on: self-hosted
steps:
# clean before building
- name: cleanup
run: |
echo "Cleaning up previous run"
sudo rm -rf "${{ github.workspace }}"
- uses: actions/checkout@v1
- name: builds docker container and pushes to docker hub
run: cd build && sh ./build.sh --dockerpush --smoketest --arc -arm
env:
DOCKER_PASS: ${{ secrets.DOCKER_PASS }}
DOCKER_USER: ${{ secrets.DOCKER_USER }}

# docker-x86:
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v1
# - name: builds docker container and pushes to docker hub
# run: cd build && sh ./build.sh --dockerpush --smoketest
# env:
# DOCKER_PASS: ${{ secrets.DOCKER_PASS }}
# DOCKER_USER: ${{ secrets.DOCKER_USER }}
docker-x86:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: builds docker container and pushes to docker hub
run: cd build && sh ./build.sh --dockerpush --smoketest
env:
DOCKER_PASS: ${{ secrets.DOCKER_PASS }}
DOCKER_USER: ${{ secrets.DOCKER_USER }}

linux-x64:
runs-on: ubuntu-latest
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@

If you're on Linux (including Raspbian) and have Docker installed, check out the [Docker installation guide](/docs/install-docker.md).

If you want to install the app directly on your host system try the [NodeJS install guide](/docs/install-nodejs.md).
If you're on Linux x64 and don't want to use Docker, you can grab a standalone executable under [releases](/releases). (These are still experimental).

If you want to install the app from source, try the [NodeJS install guide](/docs/install-nodejs.md).

## Config

Expand Down
42 changes: 21 additions & 21 deletions docs/install-docker.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Setup with Docker

Docker images are available @ https://hub.docker.com/r/shukriadams/arewedown. Find an up-to-date tag there (this project does not build `:latest`). If you intend to run on a Pi, use `<TAG>-arm`

- An example docker-compose.yml is

version: "2"
services:
arewedown:
image: shukriadams/arewedown:<TAG-HERE>
container_name: arewedown
restart: unless-stopped
volumes:
- ./config:/etc/arewedown/config
- ./logs:/etc/arewedown/logs/:rw
# - ./scripts:/etc/arewedown/custom-tests # optional, see "custom tests" section of documentation
ports:
- "3000:3000"

- Two directory volume mounts are required, one for logs, the other for config.
- Ensure write access to the `logs` directory, the container runs with user id 1000, use `chown -R 1000 path/to/logs` to enable writes, or the app will fail.
# Setup with Docker

Docker images are available @ https://hub.docker.com/r/shukriadams/arewedown. Find an up-to-date tag there (this project does not build `:latest`). If you intend to run on a Raspberry Pi, use `<TAG>-arm`

- An example docker-compose.yml is

version: "2"
services:
arewedown:
image: shukriadams/arewedown:<TAG>
container_name: arewedown
restart: unless-stopped
volumes:
- ./config:/etc/arewedown/config
- ./logs:/etc/arewedown/logs/:rw
# - ./scripts:/etc/arewedown/custom-tests # optional, see "custom tests" section of documentation
ports:
- "3000:3000"

- Two directory volume mounts are required, one for logs, the other for config.
- Ensure write access to the `logs` directory, the container runs with user id 1000, use `chown -R 1000 path/to/logs` to enable writes, or the app will fail.
- Create an empty `settings.yml` file in the config directory, this is where all application settings live.

0 comments on commit 5c8787f

Please sign in to comment.