From 6f8fb21787ce34353586a89b3647730e1583e01e Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Sat, 1 Mar 2025 11:01:15 +1100 Subject: [PATCH] docs, GH Actions --- .github/workflows/social_post_on_release.yml | 12 +++++++++++- dockerfiles/README.md | 2 +- docs/DEBUG_TIPS.md | 2 +- docs/DOCKER_COMPOSE.md | 6 +++--- docs/FILE_PERMISSIONS.md | 2 +- docs/MIGRATION.md | 4 ++-- docs/PERFORMANCE.md | 2 +- docs/REVERSE_DNS.md | 4 ++-- docs/REVERSE_PROXY.md | 2 +- docs/SYNOLOGY_GUIDE.md | 2 +- 10 files changed, 24 insertions(+), 14 deletions(-) diff --git a/.github/workflows/social_post_on_release.yml b/.github/workflows/social_post_on_release.yml index 0d697546d..b68abcd54 100755 --- a/.github/workflows/social_post_on_release.yml +++ b/.github/workflows/social_post_on_release.yml @@ -25,13 +25,23 @@ jobs: - name: Checkout repository uses: actions/checkout@v3 + - name: Set Git config + run: | + git config --global user.email "github-actions@github.com" + 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 diff --git a/dockerfiles/README.md b/dockerfiles/README.md index 3948fe1cd..f7b01f218 100755 --- a/dockerfiles/README.md +++ b/dockerfiles/README.md @@ -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). diff --git a/docs/DEBUG_TIPS.md b/docs/DEBUG_TIPS.md index d973f946e..3d626db5b 100755 --- a/docs/DEBUG_TIPS.md +++ b/docs/DEBUG_TIPS.md @@ -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 ``` diff --git a/docs/DOCKER_COMPOSE.md b/docs/DOCKER_COMPOSE.md index 3bdeded08..db0deddc1 100755 --- a/docs/DOCKER_COMPOSE.md +++ b/docs/DOCKER_COMPOSE.md @@ -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: @@ -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 @@ -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: diff --git a/docs/FILE_PERMISSIONS.md b/docs/FILE_PERMISSIONS.md index fd1f545eb..e9b757a88 100755 --- a/docs/FILE_PERMISSIONS.md +++ b/docs/FILE_PERMISSIONS.md @@ -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`. diff --git a/docs/MIGRATION.md b/docs/MIGRATION.md index 044336393..4b0db2324 100755 --- a/docs/MIGRATION.md +++ b/docs/MIGRATION.md @@ -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: @@ -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: diff --git a/docs/PERFORMANCE.md b/docs/PERFORMANCE.md index 7d0ec10d0..00a1d5f05 100755 --- a/docs/PERFORMANCE.md +++ b/docs/PERFORMANCE.md @@ -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: diff --git a/docs/REVERSE_DNS.md b/docs/REVERSE_DNS.md index 5cd05db8f..4f0f1fc5c 100755 --- a/docs/REVERSE_DNS.md +++ b/docs/REVERSE_DNS.md @@ -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 @@ -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 diff --git a/docs/REVERSE_PROXY.md b/docs/REVERSE_PROXY.md index 1e2187037..81c346929 100755 --- a/docs/REVERSE_PROXY.md +++ b/docs/REVERSE_PROXY.md @@ -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 ``` diff --git a/docs/SYNOLOGY_GUIDE.md b/docs/SYNOLOGY_GUIDE.md index b5c54085e..15b38a38c 100755 --- a/docs/SYNOLOGY_GUIDE.md +++ b/docs/SYNOLOGY_GUIDE.md @@ -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: