{"id":15997837,"url":"https://github.com/luan/teapot","last_synced_at":"2025-09-04T16:33:46.511Z","repository":{"id":138431371,"uuid":"27152835","full_name":"luan/teapot","owner":"luan","description":null,"archived":false,"fork":false,"pushed_at":"2015-02-17T16:31:40.000Z","size":3568,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-01T07:44:11.589Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-26T00:35:42.000Z","updated_at":"2015-02-17T16:31:40.000Z","dependencies_parsed_at":"2023-03-30T06:09:51.075Z","dependency_job_id":null,"html_url":"https://github.com/luan/teapot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luan%2Fteapot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luan%2Fteapot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luan%2Fteapot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luan%2Fteapot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luan","download_url":"https://codeload.github.com/luan/teapot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245767813,"owners_count":20668921,"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-08T08:04:26.143Z","updated_at":"2025-03-27T02:23:25.838Z","avatar_url":"https://github.com/luan.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Teapot [![Build Status](https://travis-ci.org/luan/teapot.svg?branch=master)](https://travis-ci.org/luan/teapot)\n\nTeapot is the API that powers [Tiego](https://github.com/luan/tiego). It's a simple, RESTful JSON API to manage cloud provided workstations backed by [Diego](https://github.com/cloudfoundry-incubator/diego-release) and [Docker](http://docker.com) images.\n\nYou can find the live API documentation here: http://docs.teapot.apiary.io/\n\n## Setup\n\nJust go get it: `go get github.com/luan/teapot`\n\n## Usage\n\nTo run the Teapot API with [Diego Edge](https://github.com/pivotal-cf-experimental/diego-edge):\n\n```bash\nteapot -address 0.0.0.0:8080 -receptorAddress http://receptor.192.168.11.11.xip.io/\n```\n\nTo run the Teapot API **on** [Diego Edge](https://github.com/pivotal-cf-experimental/diego-edge):\n\n```bash\ncd $GOPATH/src/github.com/luan/teapot\nexport RECEPTOR=http://receptor.192.168.11.11.xip.io/\nbin/dance # optionally provide a bucket name, default: tiego-artifacts\n```\n\nYou can replace the receptor URL with your receptor for other types of deployments, receptors with Basic Auth enabled should work out of the box with something like `http://user:password@receptor.example.com`.\n\n## Development flow\n\nTo deploy the Teapot to a Diego, we use a [minimal busybox image](https://github.com/jpetazzo/docker-busybox/blob/4f6cb64c3b3255c58021dc75100da0088796a108/Dockerfile) and download the compiled binary for Teapot and the [spy](https://github.com/cloudfoundry-incubator/docker-circus/tree/master/spy) from the [docker-circus](https://github.com/cloudfoundry-incubator/docker-circus).\n\nThe Teapot binary is stored on an S3 bucket, so before you deploy your changes to your Diego environment you need to get s3 working.\n\nAlso, if you're not developing from a linux workstation, you will need golang with [cross-compile support](#golang-cross-compile-on-osx).\n\n\n### Install \u0026 Configure s3cmd\n```bash\n# for OSX\nbrew install s3cmd\n# for debian based linux distros\nsudo apt-get install -y s3cmd\ns3cmd --configure # enter credentials Amazon S3 enabled account\n```\n\n### Build \u0026 Upload\n\n```bash\nbin/build\nbin/upload # optionally provide a bucket name, default: tiego-artifacts\nbin/deploy\n```\n\nOr you can use `bin/dance [BUCKET]` for convenicence\n\nAfter this you can deploy Teapot using `bin/deploy`, as explained above.\n\n### Golang cross-compile on OSX:\n\n```bash\nbrew install go --cross-compile-all # or reinstall if you already had it installed\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluan%2Fteapot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluan%2Fteapot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluan%2Fteapot/lists"}