a client to control your server.
for the server-control-api
use the following as a basic example:
on: [push]
jobs:
server_control_client_job:
runs-on: ubuntu-latest
name: A job to control your server
steps:
- uses: actions/checkout@v4
- id: scc-pull-image
uses: 3n3a/server-control-client@v1
with:
key: ${{ secrets.SCC_KEY }}
base_url: ${{ secrets.SCC_BASE_URL }}
command: image_pull
option: docker.io/library/busybox
container_restart
- id: scc-restart-container
uses: 3n3a/server-control-client@v1
with:
key: ${{ secrets.SCC_KEY }}
base_url: ${{ secrets.SCC_BASE_URL }}
command: container_restart
option: busybox
service_restart
- id: scc-restart-container
uses: 3n3a/server-control-client@v1
with:
key: ${{ secrets.SCC_KEY }}
base_url: ${{ secrets.SCC_BASE_URL }}
command: service_restart
option: sample.service
use the following for additional options:
- user_agent
- extra_headers
on: [push]
jobs:
server_control_client_advanced_job:
runs-on: ubuntu-latest
name: A job to control your server (Advanced)
steps:
- uses: actions/checkout@v4
- id: scc-pull-image
uses: 3n3a/server-control-client@v1
with:
key: ${{ secrets.SCC_KEY }}
base_url: ${{ secrets.SCC_BASE_URL }}
command: image_pull
option: docker.io/library/busybox
# advanced
user_agent: "your-custom-user-agent/1.0"
extra_headers: "-H 'Tracking-Id: 1234'"
copy the scs.sh
to wherever you need it
name | description |
---|---|
SCC_BASE_URL |
Base Url for the Server control api |
SCC_KEY |
Server Control Api Key |
SCC_UA |
(OPTIONAL) Custom User Agent for Client |
SCC_EXTRA_HEADERS |
(OPTIONAL) Extra headers as a comma-separated string |
pull image
./scc.sh image_pull <image>
restart container
./scc.sh container_restart <container>
restart systemd service
./scc.sh service_restart <service>