{"id":21965775,"url":"https://github.com/arkaeriit/soft-serve_monitor","last_synced_at":"2025-04-24T03:45:19.675Z","repository":{"id":45165851,"uuid":"440671166","full_name":"Arkaeriit/Soft-Serve_Monitor","owner":"Arkaeriit","description":"A web interface for a soft serve Git server.","archived":false,"fork":false,"pushed_at":"2022-09-12T15:58:27.000Z","size":21,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-24T03:45:13.848Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Arkaeriit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-12-21T22:52:56.000Z","updated_at":"2023-10-08T12:06:39.000Z","dependencies_parsed_at":"2023-01-18T05:00:48.875Z","dependency_job_id":null,"html_url":"https://github.com/Arkaeriit/Soft-Serve_Monitor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkaeriit%2FSoft-Serve_Monitor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkaeriit%2FSoft-Serve_Monitor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkaeriit%2FSoft-Serve_Monitor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arkaeriit%2FSoft-Serve_Monitor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Arkaeriit","download_url":"https://codeload.github.com/Arkaeriit/Soft-Serve_Monitor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250559994,"owners_count":21450168,"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","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":[],"created_at":"2024-11-29T12:52:00.404Z","updated_at":"2025-04-24T03:45:19.653Z","avatar_url":"https://github.com/Arkaeriit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Soft Serve monitor\n\n[Soft Serve](https://github.com/charmbracelet/soft-serve) is a very nice git server. It offers a really nice TUI to browse the repositories on the server. Unfortunately, it does not offers a web interface. Here, I want to try to make a tiny web interface to present the git server and list the repositories there.\n\nI use this to give a web interface to my [personal Git server](https://git.bobignou.red).\n\n## What is on the web interface\n\nThe web interface offers a home page that list all the repositories in the server. The name of each repository is a link to it's page.\n\n![Home page](https://i.imgur.com/rHGMz2Y.png)\n\nIn the page of each repository, there is the command to clone the repository and a render of the README file.\n\n![A repository page](https://i.imgur.com/7F1vRn2.png)\n\n## Configuration\n\nTo tell the web server what files to monitor and how to login to the Soft Serve server, a JSON configuration file is needed. The JSON file needs the following fields:\n\n| Field name     | Description                                                   | Example                  |\n|----------------|---------------------------------------------------------------|--------------------------|\n| `ss_host`      | The host name of URL of the Soft Serve server.                | \"git.bobignou.red\"       |\n| `ss_port`      | The port used by the Soft Serve server.                       | 23231                    |\n| `repos_path`   | The path to the folder where the git repositories are located | \"/srv/soft-serve/.repos\" |\n| `monitor_port` | Port uses by the Flask web server.                            | 8080                     |\n| `monitor_name` | A name to display to describe the server.                     | Bobignou                 |\n\nThis JSON file should be given as argument when running the Flask server executable.\n\nAn example is given as `config.json` in this repository.\n\n## Running the server\n\nThis server depends on the following python libraries:\n\n* Flask\n* markdown\n\nYou need to install them before being able to run it.\n\nRunning this server is as easy as running any other Flask server. I use the following systemd service to run it on [my personal server](https://git.bobignou.red).\n```\n[Unit]\nDescription=A soft-serve web interface\nAfter=network.target\n\n[Service]\nType=simple\n# Another Type: forking\nUser=root\nGroup=root\nWorkingDirectory=/srv/data/soft-serve\nExecStart=/srv/soft-serve/soft-serve_monitor/soft-serve_monitor.py /srv/soft-serve/soft-serve_monitor/config.json\nRestart=on-failure\n\n[Install]\nWantedBy=multi-user.target\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkaeriit%2Fsoft-serve_monitor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farkaeriit%2Fsoft-serve_monitor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farkaeriit%2Fsoft-serve_monitor/lists"}