Skip to content

Commit

Permalink
docs, GH Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
jokob-sk committed Mar 1, 2025
1 parent 4b0c7f2 commit 6f8fb21
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 14 deletions.
12 changes: 11 additions & 1 deletion .github/workflows/social_post_on_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,23 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set Git config
run: |
git config --global user.email "[email protected]"
git config --global user.name "GitHub Actions"
- name: Create tweet file
run: |
echo "🎉 New release: **${{ github.event.release.name }}** is live! 🚀" > .github/tweet.md
echo "Check it out here: ${{ github.event.release.html_url }}" >> .github/tweet.md
git add .github/tweet.md
git commit -m "Add release tweet for ${{ github.event.release.name }}"
git push
- name: Push changes
run: |
git push https://github.com/${{ github.repository }}.git HEAD:main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Tweet
uses: twitter-together/action@v3
Expand Down
2 changes: 1 addition & 1 deletion dockerfiles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ docker run -d --rm --network=host \
-e PUID=200 -e PGID=300 \
-e TZ=Europe/Berlin \
-e PORT=20211 \
jokobsk/netalertx:latest
ghcr.io/jokob-sk/netalertx:latest
```

See alternative [docked-compose examples](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DOCKER_COMPOSE.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/DEBUG_TIPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ docker run --rm --network=host \
-v local/path/netalertx/db:/app/db \
-e TZ=Europe/Berlin \
-e PORT=20211 \
jokobsk/netalertx:latest
ghcr.io/jokob-sk/netalertx:latest

```

Expand Down
6 changes: 3 additions & 3 deletions docs/DOCKER_COMPOSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ services:
container_name: netalertx
# use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/netalertx:latest"
image: "ghcr.io/jokob-sk/netalertx:latest"
network_mode: "host"
restart: unless-stopped
volumes:
Expand Down Expand Up @@ -40,7 +40,7 @@ services:
privileged: true
# use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: jokobsk/netalertx:latest
image: ghcr.io/jokob-sk/netalertx:latest
environment:
- TZ=Europe/Bratislava
restart: always
Expand All @@ -62,7 +62,7 @@ services:
container_name: netalertx
# use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/netalertx:latest"
image: "ghcr.io/jokob-sk/netalertx:latest"
network_mode: "host"
restart: unless-stopped
volumes:
Expand Down
2 changes: 1 addition & 1 deletion docs/FILE_PERMISSIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
> -e TZ=Europe/Berlin \
> -e PUID=200 -e PGID=200 \
> -e PORT=20211 \
> jokobsk/netalertx:latest
> ghcr.io/jokob-sk/netalertx:latest
> ```
NetAlertX runs on an Nginx web server. On Alpine Linux, Nginx operates as the `nginx` user (if PUID and GID environment variables are not specified, nginx user UID will be set to 102, and its supplementary group `www-data` ID to 82). Consequently, files accessed or written by the NetAlertX application are owned by `nginx:www-data`.
Expand Down
4 changes: 2 additions & 2 deletions docs/MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ services:
container_name: netalertx # ⚠ This has changed (🟡optional)
# use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/netalertx:latest" # ⚠ This has changed (🟡optional/🔺required in future)
image: "ghcr.io/jokob-sk/netalertx:latest" # ⚠ This has changed (🟡optional/🔺required in future)
network_mode: "host"
restart: unless-stopped
volumes:
Expand Down Expand Up @@ -128,7 +128,7 @@ services:
container_name: netalertx # ⚠ This has changed (🟡optional)
# use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/netalertx:latest" # ⚠ This has changed (🟡optional/🔺required in future)
image: "ghcr.io/jokob-sk/netalertx:latest" # ⚠ This has changed (🟡optional/🔺required in future)
network_mode: "host"
restart: unless-stopped
volumes:
Expand Down
2 changes: 1 addition & 1 deletion docs/PERFORMANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ services:
container_name: netalertx
# Uncomment the line below to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/netalertx:latest"
image: "ghcr.io/jokob-sk/netalertx:latest"
network_mode: "host"
restart: unless-stopped
volumes:
Expand Down
4 changes: 2 additions & 2 deletions docs/REVERSE_DNS.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You can specify the DNS server in the docker-compose to improve name resolution
services:
netalertx:
container_name: netalertx
image: "jokobsk/netalertx:latest"
image: "ghcr.io/jokob-sk/netalertx:latest"
restart: unless-stopped
volumes:
- /home/netalertx/config:/app/config
Expand All @@ -60,7 +60,7 @@ version: "3"
services:
netalertx:
container_name: netalertx
image: "jokobsk/netalertx:latest"
image: "ghcr.io/jokob-sk/netalertx:latest"
restart: unless-stopped
volumes:
- ./config/app.conf:/app/config/app.conf
Expand Down
2 changes: 1 addition & 1 deletion docs/REVERSE_PROXY.md
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ docker run -d --rm --network=host \
-v /appl/docker/netalertx/default:/etc/nginx/sites-available/default \
-e TZ=Europe/Amsterdam \
-e PORT=20211 \
jokobsk/netalertx:latest
ghcr.io/jokob-sk/netalertx:latest

```

2 changes: 1 addition & 1 deletion docs/SYNOLOGY_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ services:
container_name: netalertx
# use the below line if you want to test the latest dev image
# image: "ghcr.io/jokob-sk/netalertx-dev:latest"
image: "jokobsk/netalertx:latest"
image: "ghcr.io/jokob-sk/netalertx:latest"
network_mode: "host"
restart: unless-stopped
volumes:
Expand Down

0 comments on commit 6f8fb21

Please sign in to comment.