{"id":15690470,"url":"https://github.com/kirillzhosul/subscriby","last_synced_at":"2025-05-07T23:46:13.159Z","repository":{"id":190497520,"uuid":"682751850","full_name":"kirillzhosul/subscriby","owner":"kirillzhosul","description":"Easy deployable system (API) for creating subscription based applications.","archived":false,"fork":false,"pushed_at":"2023-11-23T11:45:51.000Z","size":118,"stargazers_count":9,"open_issues_count":5,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T23:46:05.747Z","etag":null,"topics":["api","docker","docker-compose","fastapi","saas","self-hosted","subscription"],"latest_commit_sha":null,"homepage":"","language":"Python","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/kirillzhosul.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":"2023-08-24T21:09:54.000Z","updated_at":"2024-01-28T21:03:13.000Z","dependencies_parsed_at":"2023-11-23T11:31:13.445Z","dependency_job_id":"1c2155d9-eb99-47d5-8a66-f7908aba5814","html_url":"https://github.com/kirillzhosul/subscriby","commit_stats":{"total_commits":68,"total_committers":4,"mean_commits":17.0,"dds":0.4558823529411765,"last_synced_commit":"7408fd5846021cf00907fd4c00192bfcb2cf7748"},"previous_names":["kirillzhosul/subscriby"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirillzhosul%2Fsubscriby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirillzhosul%2Fsubscriby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirillzhosul%2Fsubscriby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kirillzhosul%2Fsubscriby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kirillzhosul","download_url":"https://codeload.github.com/kirillzhosul/subscriby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252973618,"owners_count":21834105,"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":["api","docker","docker-compose","fastapi","saas","self-hosted","subscription"],"created_at":"2024-10-03T18:10:14.161Z","updated_at":"2025-05-07T23:46:13.140Z","avatar_url":"https://github.com/kirillzhosul.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🔐 Subscriby\n\nEasy deployable system (API) for creating subscription based applications\n\n# Use case\n\n- You have desktop or other application that requires subscription\n- You want to use subscription-like tokens/keys\n\n# How to use\n\n- Deploy API on the your server\n- Query your subscription key from user inside your application (fetch API call)\n- Create and manage new subscription for users (by hand, implementing own management tool, or use premade inside `frontends` directory)\n\n# Notice\n\nProject does provide support for storing / analysing (KPI) of prices/revenue, but not the purchasing via any payment provider or etc, you can write own frontend for that or publishing subscriptions by own\n\n# Authorization\n\n`SUBSCRIBY_AUTH_METHOD` Auth methods to use\n\n- `none`: No additional authorization\n- `secret`: Require `secret` GET field or `Authorization` header (with or without `Bearer`) which should equals to `SUBSCRIBY_AUTH_SECRET`\n- `custom`: Will call `plugins/custom_auth` plugin with your own code.\n\n# Frontends\n\n- Telegram bot [`frontends/telegram`](frontends/telegram)\n\n# Features\n\n- Creating new subscriptions\n- Checking subscription status\n- Revoking subscriptions\n- Analytics (KPI, even for your payload via plugin)\n- Custom payload injected within subscriptions\n- Auth for system methods (publish, revoke)\n- Webhook notification for clients\n\n# Plugins\n\nThere is support for custom plugins for:\n\n- Auth (Check own custom auth)\n- Payload (Inject custom payload with or without validation)\n- Analytics (Inject own KPI trackers)\n\n# Deployment\n\n(How to deploy API)\n\n- Do `git clone` on your server\n- Edit `backend/.example.env` and copy to `.env`\n- Run `docker compose up -d` inside `backend` directory\n\n# Built stack\n\n- Python (FastAPI)\n- PostgreSQL (SQLAlchemy)\n- Docker\n- Gunicorn with Uvicorn under the hood\n\n# Running behing a proxy\n\nShould be same as default deployment but you have to declare proxy to the API (Like, for NGINX)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirillzhosul%2Fsubscriby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkirillzhosul%2Fsubscriby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkirillzhosul%2Fsubscriby/lists"}