{"id":18085439,"url":"https://github.com/xe/surl","last_synced_at":"2025-04-06T00:15:32.588Z","repository":{"id":144742259,"uuid":"180401448","full_name":"Xe/surl","owner":"Xe","description":"My simple URL shortener for my internal network.","archived":false,"fork":false,"pushed_at":"2019-06-24T17:38:42.000Z","size":204,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T11:52:13.117Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Nim","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/Xe.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":"2019-04-09T15:50:50.000Z","updated_at":"2023-06-14T05:51:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"79e8710f-1fb3-4dec-a3a8-f450f8b49f52","html_url":"https://github.com/Xe/surl","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xe%2Fsurl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xe%2Fsurl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xe%2Fsurl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xe%2Fsurl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Xe","download_url":"https://codeload.github.com/Xe/surl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415966,"owners_count":20935387,"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-10-31T15:11:21.453Z","updated_at":"2025-04-06T00:15:32.550Z","avatar_url":"https://github.com/Xe.png","language":"Nim","funding_links":[],"categories":[],"sub_categories":[],"readme":"# surl\n\nMy custom URL shortener. I have it mounted at https://g.o/.\n\n## Configuration\n\nTo use this:\n\n| Environment Variable | Value                                                                                            |\n| :------------------ | :------------- |\n| `DATABASE_PATH`      | `/data/surl.db`                                                                                  |\n| `DOMAIN`             | `g.o`                                                                                            |\n| `PORT`               | `5000`                                                                                           |\n| `THEME`              | `solarized.css` (or `gruvbox.css`, put themes [here](https://github.com/Xe/surl/tree/master/public/css)) |\n\n```\ndocker volue create surl\ndocker run --name surl -dit -p 127.0.0.1:45273:5000 \\\n  -e DOMAIN=g.o -v surl:/data xena/surl:v0.3.0\n```\n\n## Serving\n\n```\n# /etc/caddy/Caddyfile\n\n## Custom DNS domain\ng.o:80 {\n  tls off\n  \n  redir / https://g.o\n}\ng.o:443 {\n  tls /srv/within/certs/g.o/cert.pem /srv/within/certs/g.o/key.pem\n  \n  proxy / http://127.0.0.1:45273\n}\n\n## Clearnet domain\nsome.clearnet.domain {\n  tls some@email.address\n  \n  proxy / http://127.0.0.1:45273\n}\n```\n\n## Releasing\n\n```\nnimble release\nnimble docker\n```\n\n## Customization\n\nBuild your CSS on top of this example CSS:\n\n```css\nmain {\n  font-family: Arial, Helvetica, sans-serif;\n  max-width: 38rem;\n  padding: 2rem;\n  margin: auto;\n}\n\nbody {\n  background: #fdf6e3;\n  color: #657b83;\n}\n\n// unclicked links\na { color: #b58900 }\n\n// clicked links\na:visited { color: #586e75; }\n\n@media (prefers-color-scheme: dark) {\n  body {\n    background: #002b36;\n    color: #839496;\n  }\n\n  // clicked links\n  a:visited { color: #93a1a1; }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxe%2Fsurl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxe%2Fsurl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxe%2Fsurl/lists"}