https://github.com/s2009-dev/servup
Upload an artifact from Github Actions to a server using SSH
https://github.com/s2009-dev/servup
actions artifacts continuous-integration curl deployment english publishing s2009 shell ssh
Last synced: 4 months ago
JSON representation
Upload an artifact from Github Actions to a server using SSH
- Host: GitHub
- URL: https://github.com/s2009-dev/servup
- Owner: S2009-dev
- License: gpl-3.0
- Created: 2025-10-05T15:40:45.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-10-05T19:10:55.000Z (4 months ago)
- Last Synced: 2025-10-05T19:11:32.332Z (4 months ago)
- Topics: actions, artifacts, continuous-integration, curl, deployment, english, publishing, s2009, shell, ssh
- Language: Shell
- Homepage:
- Size: 103 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [](.)
## About
ServUP is a lightweight, open-source, and easy-to-use deployment tool designed to simplify the process of deploying artifact from GitHub Actions to remote servers. It provides a simple and efficient way to manage your deployments, ensuring that your applications are always up-to-date and running.
### Index
- [About](#about)
- [Index](#index)
- [Features](#features)
- [Installation](#installation)
- [Server Configuration](#server-configuration)
- [Repository Configuration](#repository-configuration)
- [Annexes](#annexes)
- [Iptables Support](#iptables-support)
- [Get a GitHub Token](#get-a-github-token)
### Features
ServUP uses SSH to securely transfer files from your GitHub Actions workflow to your remote server.
## Installation
In order to work with ServUP, you need to do some configuration on your server and your GitHub repository.
### Server Configuration
Install ServUP on your server via the command-line with curl:
```sh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/S2009-dev/ServUP/main/tools/install.sh)"
```
This will create a `servup` user on your server and open a specific port for SSH connections (`1424` by default).
Ensure that you've copied the ServUP SSH Key given at the end of installation.
If you have a firewall, make sure to open the port given at the end of installation.
You can trust only GitHub Actions IPs, they are listed in the `actions` section of the [GitHub meta API](https://api.github.com/meta).
We provide a script to help you configure your firewall if you are using `iptables` or `ip6tables`. See [Iptables Support](#iptables-support) for more information.
### Repository Configuration
**1. Add the following secrets to your GitHub repository:**
- `GH_TOKEN`: A GitHub token with the `actions:read` permission.
- `SSH_HOST`: The IP address or domain name of your server.
- `SSH_PORT`: The port used by ServUP for SSH connections (default: `1424`).
- `SSH_PRIVATE_KEY`: The private key of the `servup` user on your server.
**2. Implement the ServUP Deployment workflow:**
:warning: The documentation is not yet available.
## Annexes
Here you will find additional tools and resources to help you use ServUP effectively.
### Iptables Support
If you are using `iptables` or `ip6tables` as your firewall, you can use the following command to open the ServUP SSH port:
```sh
servup-firewall
```
Or if it's not working:
```sh
sh -c "$(curl -fsSL https://raw.githubusercontent.com/S2009-dev/ServUP/main/tools/firewall.sh)"
```
### Get a GitHub Token
To get a GitHub token for ServUP, follow these steps:
- Go to [https://github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new)
- Choose a name for your token (e.g., `ServUP`).
- Add a description (optionnal, e.g., `ServUP Deployment Token`).
- Set the resource owner to your account or organization.
- Choose the expiration date (recommended: `90 days`).
- Set the repository access to `All repositories`.
- Click on `Add permissions` and check `Actions`.
- Click on `Generate token`.
- Copy the token and save it in a secure place.