{"id":25477616,"url":"https://github.com/notkamui/servmon","last_synced_at":"2026-05-05T22:42:14.259Z","repository":{"id":252639385,"uuid":"841007288","full_name":"notKamui/servmon","owner":"notKamui","description":"Very small utility for managing services with Docker","archived":false,"fork":false,"pushed_at":"2024-08-11T16:42:36.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-12T12:55:36.027Z","etag":null,"topics":["devops","docker","docker-compose","server","sysadmin"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/notKamui.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}},"created_at":"2024-08-11T11:16:34.000Z","updated_at":"2024-08-11T16:42:39.000Z","dependencies_parsed_at":"2024-08-11T12:52:33.765Z","dependency_job_id":"479feb2b-ea08-4033-87e7-942345466d5f","html_url":"https://github.com/notKamui/servmon","commit_stats":null,"previous_names":["notkamui/servmon"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notKamui%2Fservmon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notKamui%2Fservmon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notKamui%2Fservmon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notKamui%2Fservmon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/notKamui","download_url":"https://codeload.github.com/notKamui/servmon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239484216,"owners_count":19646429,"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":["devops","docker","docker-compose","server","sysadmin"],"created_at":"2025-02-18T13:51:14.175Z","updated_at":"2025-11-06T06:30:30.095Z","avatar_url":"https://github.com/notKamui.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# servmon\n\nA simple utility script (with autocompletion) to manage your services with docker, with automatic SSL certificates.\n\n## Installing and updating\n\nInstall (or update) using curl:\n\n```sh\ncurl -fsSL https://servmon.notkamui.com/install.sh | sh\n```\n\nor \n\n```sh\ncurl -fsSL https://raw.githubusercontent.com/notKamui/servmon/main/install.sh | sh\n```\n\n## Creating a new service\n\nHere is a simple walkthrough to create a service which will host a static webpage.\n\n### The web proxy\n\nFirst, you need to make sure that the web-proxy service is running. \nThe configuration should have been created automatically upon servmon's installation.\nIf you don't have it anymore, you can get it [here](https://github.com/notKamui/servmon/tree/main/web-proxy).\n\nTo start it, you can run:\n\n```sh\nservmon start web-proxy\n```\n\nThe web-proxy actually contains two services:\n- the actual nginx proxy\n- an acme companion instance which will manage your SSL certificates for you.\n\nIt also declares a external network `web-proxy` based on the default bridge. All your services should belong to this network.\n\n### The webpage\n\nSay you want to serve an `index.html` (the content isn't relevant for this tutorial) thanks to an nginx server.\n\nSimply create a new folder `webpage` (or anything you want) within the `~/services` directory, and inside it, create a new `docker-compose.yml` file.\nAdditionally, alongside the compose file, create a folder which will hold the static assets you want to serve (the `index.html`).\n\nThe directory tree should look something like this:\n\n```\n$HOME/services/\n  - web-proxy/\n    - docker-compose.yml\n  - webpage/\n    - docker-compose.yml\n    - assets/\n      - index.html\n      - favicon.ico\n```\n\nHere is an example of what the docker compose file should look like:\n\n```yml\nversion: \"3\"\nservices:\n  webpage:\n    image: nginx\n    container_name: webpage\n    environment:\n      - VIRTUAL_HOST=yourdomain.com,www.yourdomain.com\n      - LETSENCRYPT_HOST=yourdomain.com,www.yourdomain.com\n    volumes:\n      - ./assets/:/usr/share/nginx/html:ro\n    restart: always\n    networks:\n      - web-proxy\n\nnetworks:\n  web-proxy:\n    name: web-proxy\n    external: true\n```\n\nNotably, at the bottom of the file, we re-declare the `web-proxy` external network, so that we can make the `webpage` service a part of it.\n\nAlso note the two environment variables: VIRTUAL_HOST and LETSENCRYPT_HOST. They should probably always hold the same value. \nThey are both lists of domains and/or subdomains, comma-separated, that you want to assign to the given service.\n\nThis configuration means that as long as, in your DNS records, you have an A record pointing to your server's IP (for `yourdomain.com`)\nand a `www` CNAME record pointing to `yourdomain.com`, clients will be able to access your website at `yourdomain.com` and `www.yourdomain.com`\n\nYou can now start the service, congratulations !\n\n```sh\nservmon start webpage # name of the folder which contains the config files\n```\n\n## Help\n\n```\nUsage: $0 [list|start|stop|restart|status|edit|monitor|help] [service]\n\u003e list: list all known services (does not require a service name)\n\u003e start: starts the service\n\u003e stop: stops the service\n\u003e restart: restarts the service\n\u003e status: shows the status of the service\n\u003e edit: edits the service configuration\n\u003e monitor: uses lazydocker monitoring (lazydocker must be installed)\n\u003e help: shows this message\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotkamui%2Fservmon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotkamui%2Fservmon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotkamui%2Fservmon/lists"}