{"id":21250910,"url":"https://github.com/natlee/telepy","last_synced_at":"2025-07-11T01:31:39.369Z","repository":{"id":223345220,"uuid":"759376315","full_name":"NatLee/telepy","owner":"NatLee","description":"A Django-based web application for managing and monitoring the reverse SSH tunnels or jump servers.","archived":false,"fork":false,"pushed_at":"2025-03-01T14:02:56.000Z","size":609,"stargazers_count":8,"open_issues_count":11,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-03T23:31:43.672Z","etag":null,"topics":["django-application","jumpserver","python","reverse-proxy","ssh-server"],"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/NatLee.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-02-18T12:29:25.000Z","updated_at":"2025-03-01T14:03:00.000Z","dependencies_parsed_at":"2024-09-15T16:01:12.914Z","dependency_job_id":"88444a26-d8e9-4dc2-9606-c5b1789b0b2a","html_url":"https://github.com/NatLee/telepy","commit_stats":null,"previous_names":["natlee/telepy"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2Ftelepy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2Ftelepy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2Ftelepy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2Ftelepy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NatLee","download_url":"https://codeload.github.com/NatLee/telepy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2Ftelepy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259035777,"owners_count":22796113,"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":["django-application","jumpserver","python","reverse-proxy","ssh-server"],"created_at":"2024-11-21T03:39:33.945Z","updated_at":"2025-07-11T01:31:38.643Z","avatar_url":"https://github.com/NatLee.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telepy\n\n![ui](https://i.imgur.com/tie5vrR.png)\n![terminal](https://i.imgur.com/l6bx20q.png)\n\nA web application for managing and monitoring the reverse SSH tunnels.\n\n## Usage\n\n1. Copy the `.env.example` to `.env` and change the environment variables.\n\n2. Generate keys for SSH server.\n\n```bash\n./telepy.sh keygen\n```\n\n3. Build and run the Docker container.\n\n```bash\ndocker-compose up\n```\n\n4. (Optional) Create a superuser for Django admin.\n\n\u003e Be aware that the first user created will be the superuser whatever the method you use. See [this function](./src/user_management/signals.py) for more details.\n\u003e So, if you want to login with Google account, just visit the login page and login with Google account.\n\nYou need to check the script `./dev-create-superuser.sh` and change the username and password if you want.\n\n```bash\n./telepy.sh create-superuser\n```\n\n\n5. Go to `http://localhost:\u003cYOUR_WEB_SERVER_PORT\u003e/login`, it will show the login page.\n\n## API Documentation\n\nIf you want to see the API documentation, you need to login first.\n\n1. Go to `http://localhost:\u003cYOUR_WEB_SERVER_PORT\u003e/api/__hidden_admin/` and login with the superuser.\n\n2. Go to `http//localhost:\u003cYOUR_WEB_SERVER_PORT\u003e/api/__hidden_swagger` and you will see the Swagger.\n\n## Misc\n\nThere are some scripts in the `dev-scripts` directory.\n\nYou can just use `./telepy.sh` to run the scripts.\n\n```bash\nUsage: ./telepy.sh sub-command [args]\nSub-commands:\n  keygen: Generate SSH keys for Telepy service.\n  create-superuser: Create an admin account for Telepy management.\n  shell: Create a shell to run arbitrary command.\n  ipython: Create a shell to run ipython.\n  supervisorctl: Attach to supervisor control shell.\n  ssh-shell: Similar to 'shell', but for ssh container.\n  migration: Run migration process.\n  backend-debug: Recreate and attach to backend container.\n  collect-static: Collect static files to increase rendering speed.\n  django-startapp: Create a new Django app.\n```\n\n\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/NatLee\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10178964?v=3?s=100\" width=\"100px;\" alt=\"Nat Lee\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eNat Lee\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/h-alice\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/16372174?v=3?s=100\" width=\"100px;\" alt=\"H. Alice\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eH. Alice\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/boris-lok\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/77889460?v=3?s=100\" width=\"100px;\" alt=\"Boris Lok\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBoris Lok\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatlee%2Ftelepy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatlee%2Ftelepy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatlee%2Ftelepy/lists"}