{"id":17146157,"url":"https://github.com/codenamev/slimer-example-docker","last_synced_at":"2025-03-24T10:25:46.154Z","repository":{"id":42617889,"uuid":"332747387","full_name":"codenamev/slimer-example-docker","owner":"codenamev","description":"An example of running Slimer on Docker.","archived":false,"fork":false,"pushed_at":"2023-04-24T20:37:19.000Z","size":20,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-29T15:50:41.624Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/codenamev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["codenamev"]}},"created_at":"2021-01-25T12:56:51.000Z","updated_at":"2021-10-12T18:58:28.000Z","dependencies_parsed_at":"2024-12-01T20:08:03.286Z","dependency_job_id":null,"html_url":"https://github.com/codenamev/slimer-example-docker","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/codenamev%2Fslimer-example-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenamev%2Fslimer-example-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenamev%2Fslimer-example-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codenamev%2Fslimer-example-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codenamev","download_url":"https://codeload.github.com/codenamev/slimer-example-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245250922,"owners_count":20584797,"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-14T21:07:58.313Z","updated_at":"2025-03-24T10:25:46.123Z","avatar_url":"https://github.com/codenamev.png","language":"Ruby","funding_links":["https://github.com/sponsors/codenamev"],"categories":[],"sub_categories":[],"readme":"# Slimer on Docker\n\nA brief example of running [Slimer](https://github.com/codenamev/slimer) on Docker.\n\n## Batteries Included\n\nThis is meant to be a turn-key solution to running Slimer on a local network.\nIt is especially useful when you need a convenient place to dump data to that is not\nin the cloud.\n\nThis specific implementation will run three containers:\n\n1. slimer – The Slimer web server that receives requests; it is configured\n   to listen on port `6660`.\n2. slimer-workers – Used to broker storage requests with Redis.\n3. slimer-redis – The Redis server used in tandem with slimer-workers.\n4. slimer-database – A PostgreSQL database to store Slimer's substances.\n\n## Prerequisites\n\n* [Docker Compose](https://docs.docker.com/compose/install/)\n\n## Setup\n\n1. Clone this repository – `git clone https://github.com/codenamev/slimer.git`\n2. `cd slimer \u0026\u0026 docker-compose up -d`\n3. Visit http://localhost:6660/status and verify Slimer responds with `Ok`.\n4. Generate an API key: `docker-compose run slimer rake slimer:api_keys:generate`, and enter a name for the key when it asks.\n\n## Consuming substances\n\nUsing the API key you generated above, you can tell Slimer to consume any\nsubstance in one of two ways. Replace any `API_KEY` in the URLs below with the\nAPI key you generated  in the Setup above.\n\n**Consume via GET request**\n\n`curl http:/localhost:6660/API_KEY/consume?store_this=this\u0026and_that=that`\n\nThe above request will create a substance with a `payload` of:\n\n```json\n{\n  \"store_this\": \"this\",\n  \"and_that\": \"that\"\n}\n```\n\n**Consume via POST request\n\nThe same request above can be made as a `POST` request:\n\n```bash\ncurl -X POST -H \"Content-Type: application/json\" \\\n  -d '{\"store_this\": \"this\", \"and_that\": \"that\"}' \\\n  http:/localhost:6660/API_KEY/consume\n```\n\n** Metadata **\n\nSubstances can be stored with metadata to describe the data being stored.\nSimply provide a `metadata` parameter in your payload and this will be stored\nseparately.\n\n## Upgrading\n\nThe upgrade process is as simple as:\n\n1. Stop any running Slimer containers – from the directory you cloned this\n   example app into, run: `docker-compose down`\n2. Upgrade Slimer: `bundle update`\n3. Re-build your Docker containers: `docker-compose build`\n4. Re-start Slimer: `docker-compose up -d`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodenamev%2Fslimer-example-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodenamev%2Fslimer-example-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodenamev%2Fslimer-example-docker/lists"}