[{"_1":2,"_152":-5,"_153":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_131":132},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_124":-5,"_125":11,"_126":17,"_127":11,"_128":-5,"_129":130},"canonicalUrl","https://hub.docker.com/r/batazor/shortlink-api/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","batazor","reponame","shortlink-api","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2020-08-14T12:38:57.972874Z","description","","is_private","last_updated","2021-07-27T13:33:06.362586Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",4020,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n\n# shortlink\n\nShortlink service \n\n[![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/batazor/shortlink)](https://pkg.go.dev/mod/github.com/batazor/shortlink)\n[![codecov](https://codecov.io/gh/batazor/shortlink/branch/main/graph/badge.svg?token=Wxz5bI4QzF)](https://codecov.io/gh/batazor/shortlink)\n[![Go Report Card](https://goreportcard.com/badge/github.com/batazor/shortlink)](https://goreportcard.com/report/github.com/batazor/shortlink)\n[![Releases](https://img.shields.io/github/release-pre/batazor/shortlink.svg)](https://github.com/batazor/shortlink/releases)\n[![LICENSE](https://img.shields.io/github/license/batazor/shortlink.svg)](https://github.com/batazor/shortlink/blob/main/LICENSE)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3510/badge)](https://bestpractices.coreinfrastructure.org/projects/3510)\n\n

\n\n

\n\n### High Level Architecture 🚀\n\n![shortlink-arhitecture](./docs/shortlink-arhitecture.png)\n\n### Architecture (miro.com)\n\n- [Low-level schema](https://miro.com/app/board/o9J_laImQpo=/)\n- [Auth](https://miro.com/app/board/o9J_lA5Wmhg=/)\n\n##### Services\n\n| Service | Description | Language/Framework | Docs |\n|-------------|---------------------------------------------|---------------------------|------------------------------------------|\n| landing | Welcome page | JS/JQuery | |\n| docs | Example blog | [Hugo](https://gohugo.io) | https://shrts.ru |\n| next | UI service | JS/NextJS | [docs](./ui/next/README.md) |\n| api | GateWay | Go | [docs](./docs/services/api.md) |\n| link | Link service | Go | [docs](./docs/services/link.md) |\n| proxy | Proxy service for redirect to original URL | TypeScript | |\n| bot | Telegram bot | JAVA | |\n| logger | Logger service | Go | |\n| metadata | Parser site by API | Go | |\n| notify | Send notify to smtp, slack, telegram | Go | |\n| shortctl | Shortlink CLI | Go | [docs](./docs/shortctl.md) |\n| csi | CSI example | Go | |\n| ory/kratos | User management service | Go | [docs](https://www.ory.sh/kratos/docs/) |\n| ory/hydra | OAuth 2.0 Provider | Go | [docs](https://www.ory.sh/keto/docs/) |\n\n### Run\n\n

DETAILS

\n\n##### Require\n\n###### Install GIT sub-repository\n\n```\ngit submodule update --init --recursive\n```\n\n##### docker-compose\n\n###### For run\n```\nmake run\n```\n\n###### For down\n```\nmake down\n```\n\n\n##### Kubernetes (1.19+)\n\n###### For run\n```\nmake minikube-up\nmake helm-shortlink-up\n```\n\n###### For down\n```\nmake minikube-down\n```\n\n##### Skaffold [(link)](https://skaffold.dev/)\n\n###### For run\n```\nmake skaffold-init\nmake skaffold-up\n```\n\n###### For down\n```\nmake skaffold-down\n```\n\n###### Debug mode\n```\nmake skaffold-debug\n```\n\n

\n\n### HTTP API\n\n![arhitecture.json](./docs/arhitecture.png)\n\n+ Import [Postman link](./docs/shortlink.postman_collection.json) for\n test HTTP API\n+ Swagger [docs](https://shortlink-org.gitlab.io/shortlink)\n\n###### Support HTTP REST API:\n\n- HTTP (chi)\n- gRPC-gateway\n- GraphQL\n- ***Optional***\n - go-kit\n - [CloudEvents](https://cloudevents.io/)\n\n### MQ\n\n+ [Kafka](https://kafka.apache.org/)\n+ [NATS](https://nats.io/)\n+ [RabbitMQ](https://www.rabbitmq.com/)\n\n### OpenTracing\n\n![http_add_link](./docs/opentracing_add_link.png)\n\n### Cloud-Native\n\n+ Development\n + [Skaffold](https://skaffold.dev/)\n + Telepresence\n+ Logger\n + [Loki](./docs/logger.md)\n + DataDog\n+ Prometheus\n + prometheus-operator\n + notify: slack, email, telegram\n+ HealthCheck\n+ Support K8S\n + Helm Chart\n + [pingcap/chaos-meshh](https://github.com/pingcap/chaos-mesh)\n + Minikube\n + Backup/Restore [(Velero)](https://velero.io/)\n + Custom CSI driver (fork [csi-driver-host-pat](https://github.com/kubernetes-csi/csi-driver-host-path))\n+ Istio\n+ MetalLB\n+ [kyverno](https://kyverno.io/) - Kubernetes Native Policy Management\n+ DataBase\n + [postgres-operator (zalando)](https://github.com/zalando/postgres-operator)\n\n### Gateway\n\n+ Traefik\n+ Nginx\n\n### UI\n\n##### ENV for UI\n\nUse `.env` file in `ui/[next/etc]` directories for setting your UI\n\n\n| Name | Default | Description |\n|:--------------------|:------------------------------------------------------------|:-----------------------------------------------------------------------------------------------|\n| NODE_ENV | - | Select: production, development, etc... |\n| SENTRY_DSN | - | Your sentry DSN |\n\n#### UI Screenshot\n\n

\n\n| Describe | Screenshot |\n|-------------------------|--------------------------------------|\n| Link Table | ![link table](./docs/next-js-ui.png) |\n\n

\n\n### Mobile\n\n+ `Hello World` on flutter ;-)\n\n### Configuration\n\n

DETAILS

\n\n##### [12 factors: ENV](https://12factor.net/config)\n\n[View ENV Variables](./docs/env.md)\n\n

\n\n### CoreDNS IP table\n\n| Service | Ip address | Description |\n|:--------|:-----------|:-----------------------------------------------|\n| store | 10.5.0.100 | Main database (postgres/mongo/cassandra/redis) |\n\n##### troubleshooting\n\nSometimes a container without a specified ip may occupy a binding\naddress of another service, which will result in `Address already in\nuse`.\n\n### Ansible\n\n

DETAILS

\n\n##### Vagrant\n\n```\ncd ops/vagrant\nvagrant up\n\ncd ops/ansible\nansible-playbook playbooks/playbook.yml\n```\n\n##### DNS/HTTP\n\n+ `ui-next.shortlink.vagrant:8081`\n\n

\n\n### GITLAB CI\n\n![](./docs/gitlab/gitlab-pipeline.png)\n\n![](./docs/gitlab/gitlab-ci.png)\n\n##### GitLab Variable\n\n- SURGE_LOGIN\n- SURGE_TOKEN\n- DANGER_GITLAB_API_TOKEN - `API TOKEN` for danger\n\n##### Support environment\n\n- Minikube\n- [Yandex Cloud](https://cloud.yandex.ru/)\n- [AWS EKS](https://aws.amazon.com/eks/)\n\n### GitHub CI\n\n- Travis action (backend/frontend)\n- Docker action\n- Helm chart\n\n## -~- THE END -~-\n\n[mergify]: https://mergify.io\n[mergify-status]: https://img.shields.io/endpoint.svg?url=https://dashboard.mergify.io/badges/batazor/shortlink&style=flat\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",4468527372,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":62,"_123":17},"content_type","creator",123922,"full_size",21447187,"id",113267852,"images",[97],{"_98":99,"_100":101,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":92,"_59":62,"_112":-5},"architecture","amd64","digest","sha256:9890310a34763da839461c4c50ce45ea4b6e40e723514ec5fa132b824dbe5934","features","last_pulled","2026-09-15T12:16:45.410253041Z","last_pushed","2021-07-21T21:46:47Z","os","linux","os_features","os_version","size","variant","2021-07-27T13:33:05.974766Z","last_updater","last_updater_username","media_type","latest","repository",9636342,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":133,"_140":141,"_129":150,"_151":11},{"_36":134,"_38":135,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":136,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":137,"_75":11,"_76":139,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":138},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_142":60,"_143":-5,"_144":-5,"_145":146},"count","next","previous","results",[147],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":148,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":62,"_123":17},[149],{"_98":99,"_100":101,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":92,"_59":62,"_112":-5},[],"canDeleteTags","actionData","errors"]

batazor/shortlink-api

Tags for batazor/shortlink-api