{"id":19356511,"url":"https://github.com/factorial-io/scotty","last_synced_at":"2025-04-13T06:22:09.523Z","repository":{"id":258262404,"uuid":"873724522","full_name":"factorial-io/scotty","owner":"factorial-io","description":"Scotty is a combination of an api server and a cli application to manage a set of short-living, docker-compose-based applications","archived":false,"fork":false,"pushed_at":"2025-04-10T07:54:42.000Z","size":6011,"stargazers_count":6,"open_issues_count":16,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T08:43:08.687Z","etag":null,"topics":["docker","docker-compose","micro-paas","paas","rust"],"latest_commit_sha":null,"homepage":"https://scotty.factorial.io/","language":"Rust","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/factorial-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-10-16T15:59:53.000Z","updated_at":"2025-04-10T07:53:07.000Z","dependencies_parsed_at":"2025-01-01T17:30:30.760Z","dependency_job_id":"c9411286-5071-4fdb-9883-d7ba4ca05707","html_url":"https://github.com/factorial-io/scotty","commit_stats":{"total_commits":407,"total_committers":4,"mean_commits":101.75,"dds":0.3415233415233415,"last_synced_commit":"ea8bbc6cc24e0a657de465a649cae890f53611c7"},"previous_names":["factorial-io/scotty"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/factorial-io%2Fscotty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/factorial-io%2Fscotty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/factorial-io%2Fscotty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/factorial-io%2Fscotty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/factorial-io","download_url":"https://codeload.github.com/factorial-io/scotty/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248671636,"owners_count":21143138,"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":["docker","docker-compose","micro-paas","paas","rust"],"created_at":"2024-11-10T07:04:41.016Z","updated_at":"2025-04-13T06:22:09.509Z","avatar_url":"https://github.com/factorial-io.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# scotty\n\n![Tests](https://github.com/factorial-io/scotty/actions/workflows/ci.yml/badge.svg)\n![Build](https://github.com/factorial-io/scotty/actions/workflows/release.yml/badge.svg)\n\n## About\n\n**scotty -- yet another micro platform as a service** is a Rust\nserver providing an API to create, start, stop or destroy a\nDocker Compose-based application on your own hardware.\n\nThe repo contains two applications:\n\n* `scotty` a Rust-based HTTP server providing an API to talk with the\n  service and to start, stop and run Docker Compose-based applications.\n  The service provides a user interface at e.g. `http://localhost:21342/`.\n  The API is documented at `http://localhost:21342/rapidoc`\n* `scottyctl`, a CLI application to talk with the service and execute\n  commands from your shell\n\n## Installation\n\nPlease have a look at the detailed installation instructions [here](docs/content/installation.md)\n\n## CLI usage\n\nYou need to pass the address to the server to the CLI, either by providing\nthe `--server`-argument or by setting the `SCOTTY_SERVER` env-var.\n\n```shell\nscottyctl help\n```\n\nwill show some help and a list of available commands. You can get help\nwith `scottyctl help \u003ccommand\u003e`. A complete list of commands is available [here](docs/content/cli.md)\n\n### Shell autocompletion\n\nMake sure to leverage `scottyctl completion $SHELL` to get autocompletion for\nyour shell, see [here](docs/content/installation.md).\n\n## Configuring the CLI\n\nThe CLI needs only two environment variables to work:\n* `SCOTTY_SERVER` the address of the server\n* `SCOTTY_ACCESS_TOKEN` the bearer token to use\n\nYou can provide the information either via env-vars or by passing the\n`--server` and `--access-token` arguments to the CLI.\n\n## Developing/Contributing\n\nWe welcome contributions! Please fork the repository, create a\nfeature branch and submit a pull-request.\n\n* Try to add tests for your bug fixes and features.\n* Use conventional commits\n\n### Requirements\n\nTo run the server locally you need to have Docker and Docker Compose\ninstalled on your local machine. You also need a recent Rust toolchain.\nTo get things up and running please start Traefik with:\n\n```shell\ncd apps/traefik\ndocker-compose up -d\n```\n\nand then start the server with:\n\n```shell\ncargo run --bin scotty  or your preferred way to run a rust binary\n```\n\n### Pre-push git hook via [cargo-husky](https://github.com/rhysd/cargo-husky)\n\nThis project uses a pre-push git-hook installed by cargo husky. It should be installed automatically.\n\n### Updating the changelog\n\nWe are using [git-cliff](https://git-cliff.org) to enforce a changelog. Please update the changelog with\nthe following command:\n\n```shell\ngit cliff \u003e changelog.md\n```\n### Create a new release\n\nWe are using `cargo-release` to patch up a new release, this is a typical\ncommand to create a new release:\n\n```shell\ncargo release --no-publish alpha -x --tag-prefix \"\"\n```\n\nAdapt to your current needs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffactorial-io%2Fscotty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffactorial-io%2Fscotty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffactorial-io%2Fscotty/lists"}