{"id":13646787,"url":"https://github.com/iBug/podzol","last_synced_at":"2025-04-21T21:31:25.644Z","repository":{"id":186482653,"uuid":"674733184","full_name":"iBug/podzol","owner":"iBug","description":"A docker container scaling, port forwarding \u0026 lifetime manager","archived":false,"fork":false,"pushed_at":"2023-10-13T19:59:42.000Z","size":143,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-14T09:46:07.239Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/iBug.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-04T16:23:31.000Z","updated_at":"2023-10-17T03:54:36.000Z","dependencies_parsed_at":"2023-10-14T20:05:24.905Z","dependency_job_id":"58343f83-9c8c-4a51-8d18-dc3a16972521","html_url":"https://github.com/iBug/podzol","commit_stats":null,"previous_names":["ibug/podzol"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iBug%2Fpodzol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iBug%2Fpodzol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iBug%2Fpodzol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iBug%2Fpodzol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iBug","download_url":"https://codeload.github.com/iBug/podzol/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223880284,"owners_count":17219094,"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-08-02T01:03:05.984Z","updated_at":"2024-11-09T20:30:33.679Z","avatar_url":"https://github.com/iBug.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# podzol\n\nA docker container scaling, port forwarding \u0026amp; lifetime manager\n\n## Usage\n\nSee `podzol help` for usage instructions.\n\n### Configuration\n\nUse `podzol defaultconfig` to generate a default configuration file. Edit as you see fit. Place the configuration file at `/etc/podzol/config.yaml` for the system-wide configuration.\n\n### Deployment\n\nPlease run the server using `127.0.0.1:port` as listen address and place Nginx or Apache2 in front of it. Then you can configure SSL/TLS and access control with Nginx.\n\n## API Reference\n\nAll API expects JSON input and produces JSON output. It is always recommended to set `Content-Type: application/json`. Certain GET endpoints may accept query parameters.\n\nAll client commands produce their request URL and body on standard error if `-v` / `--verbose` is specified.\n\n### Base types\n\nBase request type:\n\n```go\ntype ContainerOptions struct {\n    // User ID\n    User     int           `json:\"user\"`\n\n    // Token to be supplied to the container\n    Token    string        `json:\"token\"`\n\n    // For identification purposes\n    AppName  string        `json:\"app\"`\n\n    // First segment of the Host header, for reverse proxying\n    Hostname string        `json:\"hostname\"`\n\n    // Docker image to be used\n    Image    string        `json:\"image\"`\n\n    // How long should podzol auto-destroy the container, in seconds\n    Lifetime time.Duration `json:\"lifetime\"`\n}\n```\n\nBase response type:\n\n```go\ntype ContainerInfo struct {\n    // Container name, ID, reverse proxy hostname\n    Name     string    `json:\"name\"`\n    ID       string    `json:\"id\"`\n    Hostname string    `json:\"hostname\"`\n\n    // When the container will expire, in Unix timestamp\n    Deadline time.Time `json:\"deadline\"`\n}\n```\n\n### Create container\n\n```\nPOST /create\n```\n\nAll fields are required.\n\nReturns a single `ContainerInfo` struct.\n\n### Remove container\n\n```\nPOST /remove\n```\n\nOnly `user` and `app` fields are required.\n\nReturns an empty object.\n\n### List containers\n\n```\nGET /list?opts=...\nPOST /list\n```\n\n`opts` is a JSON-encoded `ContainerOptions` struct. Only `user` and `app` fields are respected, if supplied.\n\nReturns a list of `ContainerInfo` structs.\n\n### Purge containers\n\nThis endpoint purges all \"expired\" containers.\n\n```\nPOST /purge\n```\n\nNo body is required.\n\nReturns a list of `ContainerInfo` structs for the containers that have been attempted to remove.\n\nUsually this endpoint is not called by an application, but rather by a cron job.\n\n## Known Issues\n\n- None\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FiBug%2Fpodzol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FiBug%2Fpodzol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FiBug%2Fpodzol/lists"}