{"id":19811913,"url":"https://github.com/hoverth/ssurlss","last_synced_at":"2025-09-18T05:32:15.920Z","repository":{"id":259650942,"uuid":"879128751","full_name":"Hoverth/ssurlss","owner":"Hoverth","description":"Super Simple URL Shortener Service","archived":false,"fork":false,"pushed_at":"2024-11-23T01:23:45.000Z","size":94,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-23T02:17:42.833Z","etag":null,"topics":["docker","rust","url-shortener"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hoverth.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-10-27T04:03:52.000Z","updated_at":"2024-11-23T01:23:48.000Z","dependencies_parsed_at":"2024-10-27T05:23:09.500Z","dependency_job_id":"d69da4ef-6a92-453b-a8d1-7d45373f6078","html_url":"https://github.com/Hoverth/ssurlss","commit_stats":null,"previous_names":["hoverth/ssurlss"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hoverth%2Fssurlss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hoverth%2Fssurlss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hoverth%2Fssurlss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hoverth%2Fssurlss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hoverth","download_url":"https://codeload.github.com/Hoverth/ssurlss/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233451304,"owners_count":18678211,"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":["docker","rust","url-shortener"],"created_at":"2024-11-12T09:28:12.052Z","updated_at":"2025-09-18T05:32:10.616Z","avatar_url":"https://github.com/Hoverth.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SSURLSS\n\n##### super simple URL shortener service\n\n![logo](./assets/favicon.png)\n\nA very lightweight URL shortener.\n\n## Usage\n\n### Standalone\n\nYou can use ssurlss standalone by manually compiling \u0026 installing it\nin a directory. Running it for the first time will generate the\n`ssurlss.toml` config file, which can be edited, and the changes\nwill take affect once ssurlss is restarted.\n\n### Docker\n\n#### Using GitHub Packages\n\nUse the supplied\n[deploy.docker-compose.yml](https://github.com/Hoverth/ssurlss/blob/main/deploy.docker-compose.yml)\n, or simply run\n\n```sh\ndocker run -p 8000:8000 \\\n           -v ./ssurlss.toml:/ssurlss.toml \\\n              ghcr.io/hoverth/ssurlss:main\n```\n\n#### Build yourself\n\nYou can build the docker image using supplied `docker-compose.yml`\nusing `docker-compose up` in a clone of this repo.\n\nTo use a specific release, change the `build: .` to\n`build: https://github.com/Hoverth/ssurlss.git#v1.1.0`\n(just change the `v1.1.0` to whatever\n[release](https://github.com/Hoverth/ssurlss/releases) you want to target).\n\n## Configuration\n\nThere are several options to configure ssurlss, which can both be\ncontrolled via changes in the config, or set via environment\nvariables (which override the config file configuration).\n\nThe following list is formatted as: `- toml_name (ENVNAME, default value) Notes`\n\n- host (HOST, `\"http://localhost:8000\"`) This is only really needed\nif allowing new entries\n- url_path (URLPATH, `\"\"`) The path that the application should use,\ne.g. `\u003chost\u003e/ssurlss/\u003csubpaths\u003e`\n- link_path (LINKPATH, `\"links\"`) The subpath that links should use,\ne.g. `\u003chost\u003e/link/\u003centry id\u003e`\n- port (PORT, `8000`) The port for the server to listen on, if using\nin docker just set the mapped port in the `docker-compose.yml`\n- allow_new (ALLOWNEW/DISALLOWNEW, `true`) Setting either envvar to\n1 will set the relevant value in the config.\n- entries_len (no envvar, `0`) A helpful tracking value for admin\npurposes, no environment variable and not used anywhere (write-only).\n\n## License\n\nThis project is licensed under the AGPL v3. See `LICENSE` for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoverth%2Fssurlss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhoverth%2Fssurlss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoverth%2Fssurlss/lists"}