{"id":31600228,"url":"https://github.com/s2009-dev/servup","last_synced_at":"2025-10-06T06:53:53.355Z","repository":{"id":318193490,"uuid":"1070262870","full_name":"S2009-dev/ServUP","owner":"S2009-dev","description":"Upload an artifact from Github Actions to a server using SSH","archived":false,"fork":false,"pushed_at":"2025-10-05T19:10:55.000Z","size":105,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-05T19:11:32.332Z","etag":null,"topics":["actions","artifacts","continuous-integration","curl","deployment","english","publishing","s2009","shell","ssh"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/S2009-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-05T15:40:45.000Z","updated_at":"2025-10-05T17:45:11.000Z","dependencies_parsed_at":"2025-10-05T19:11:38.987Z","dependency_job_id":"c36e06b8-bb29-44cf-96b3-7e03493c92be","html_url":"https://github.com/S2009-dev/ServUP","commit_stats":null,"previous_names":["s2009-dev/servup"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/S2009-dev/ServUP","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/S2009-dev%2FServUP","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/S2009-dev%2FServUP/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/S2009-dev%2FServUP/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/S2009-dev%2FServUP/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/S2009-dev","download_url":"https://codeload.github.com/S2009-dev/ServUP/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/S2009-dev%2FServUP/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278572004,"owners_count":26008686,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","artifacts","continuous-integration","curl","deployment","english","publishing","s2009","shell","ssh"],"created_at":"2025-10-06T06:53:51.613Z","updated_at":"2025-10-06T06:53:53.346Z","avatar_url":"https://github.com/S2009-dev.png","language":"Shell","readme":"\u003c!-- ###############################################\n# ServUP  Copyright (C) 2025  S2009                #\n# LICENSE: GPL-3.0                                 #\n# Source Code: https://github.com/S2009-dev/ServUP #\n#################################################### --\u003e\n\n# \u003ccenter\u003e[![ServUp Banner](./src/logo.png)](.)\u003c/center\u003e\n\n![GitHub Release](https://img.shields.io/github/v/release/S2009-dev/ServUP)\n![GitHub last commit](https://img.shields.io/github/last-commit/S2009-dev/ServUP)\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/S2009-dev/ServUP/total)\n![GitHub forks](https://img.shields.io/github/forks/S2009-dev/ServUP)\n![GitHub Repo stars](https://img.shields.io/github/stars/S2009-dev/ServUP)\n\n## About\n\nServUP 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.\n\n### Index\n\n- [About](#about)\n  - [Index](#index)\n  - [Features](#features)\n- [Installation](#installation)\n  - [Server Configuration](#server-configuration)\n  - [Repository Configuration](#repository-configuration)\n- [Annexes](#annexes)\n  - [Iptables Support](#iptables-support)\n  - [Get a GitHub Token](#get-a-github-token)\n\n### Features\n\nServUP uses SSH to securely transfer files from your GitHub Actions workflow to your remote server.\n\n## Installation\n\nIn order to work with ServUP, you need to do some configuration on your server and your GitHub repository.\n\n### Server Configuration\n\nInstall ServUP on your server via the command-line with curl:\n\n```sh\nsh -c \"$(curl -fsSL https://raw.githubusercontent.com/S2009-dev/ServUP/main/tools/install.sh)\"\n```\n\nThis will create a `servup` user on your server and open a specific port for SSH connections (`1424` by default).  \nEnsure that you've copied the ServUP SSH Key given at the end of installation.\n\nIf you have a firewall, make sure to open the port given at the end of installation.  \nYou can trust only GitHub Actions IPs, they are listed in the `actions` section of the [GitHub meta API](https://api.github.com/meta).  \nWe provide a script to help you configure your firewall if you are using `iptables` or `ip6tables`. See [Iptables Support](#iptables-support) for more information.\n\n### Repository Configuration\n\n**1. Add the following secrets to your GitHub repository:**\n\n- `GH_TOKEN`: A GitHub token with the `actions:read` permission.\n- `SSH_HOST`: The IP address or domain name of your server.\n- `SSH_PORT`: The port used by ServUP for SSH connections (default: `1424`).\n- `SSH_PRIVATE_KEY`: The private key of the `servup` user on your server.\n\n**2. Implement the ServUP Deployment workflow:**  \n:warning: The documentation is not yet available.\n\n## Annexes\n\nHere you will find additional tools and resources to help you use ServUP effectively.\n\n### Iptables Support\n\nIf you are using `iptables` or `ip6tables` as your firewall, you can use the following command to open the ServUP SSH port:\n\n```sh\nservup-firewall\n```\n\nOr if it's not working:\n\n```sh\nsh -c \"$(curl -fsSL https://raw.githubusercontent.com/S2009-dev/ServUP/main/tools/firewall.sh)\"\n```\n\n### Get a GitHub Token\n\nTo get a GitHub token for ServUP, follow these steps:\n\n- Go to [https://github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new)\n- Choose a name for your token (e.g., `ServUP`).\n- Add a description (optionnal, e.g., `ServUP Deployment Token`).\n- Set the resource owner to your account or organization.\n- Choose the expiration date (recommended: `90 days`).\n- Set the repository access to `All repositories`.\n- Click on `Add permissions` and check `Actions`.\n- Click on `Generate token`.\n- Copy the token and save it in a secure place.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs2009-dev%2Fservup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fs2009-dev%2Fservup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs2009-dev%2Fservup/lists"}