{"id":20850444,"url":"https://github.com/noteed/hicks","last_synced_at":"2025-10-18T14:14:49.777Z","repository":{"id":24116462,"uuid":"27504711","full_name":"noteed/hicks","owner":"noteed","description":"Hicks happily spawns machines.","archived":false,"fork":false,"pushed_at":"2017-04-08T21:21:59.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-19T06:11:32.834Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noteed.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}},"created_at":"2014-12-03T19:51:03.000Z","updated_at":"2017-04-08T21:22:01.000Z","dependencies_parsed_at":"2022-08-05T20:45:10.418Z","dependency_job_id":null,"html_url":"https://github.com/noteed/hicks","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/noteed%2Fhicks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noteed%2Fhicks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noteed%2Fhicks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noteed%2Fhicks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noteed","download_url":"https://codeload.github.com/noteed/hicks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243216115,"owners_count":20255317,"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-11-18T03:09:31.677Z","updated_at":"2025-10-18T14:14:49.665Z","avatar_url":"https://github.com/noteed.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hicks\n\nHicks happily spawns machines.\n\nHicks is a simple tool to spawn and provision machines. Currently only\n[UpCloud](http://upcloud.com/) is supported but in the future, other services\nshould be added (e.g. [DigitalOcean](https://www.digitalocean.com/),\n[Linode](https://www.linode.com/), [Vagrant](https://www.vagrantup.com/), or\nalready existing hosts (e.g. physical servers rented by the month)).\n\n## Getting started\n\nHicks is in development and not yet released on Hackage. To install, clone this\nrepository and run `cabal install`:\n\n    \u003e git clone https://github.com/noteed/hicks.git\n    \u003e cd hicks\n    \u003e cabal install\n\nMake sure you have `~/.cabal/bin` in your `PATH` and you can run `hicks --help`\nto see the available commands.\n\nYou need an account on UpCloud. You also need to generate API credentials for\nyour account that you paste in `secret/upcloud-key.txt`.\n\n    \u003e cat secret/upcloud-key.txt\n    api_username/api_password\n\nAt this point you should be able to run:\n\n    \u003e hicks account\n    username: noteed\n    credits: 4625.72\n\nThis command reports your username and available credits (in cents).\n\n## Next steps\n\nHave a look at the `test-against-upcloud.sh` script. It shows the basic\noperations you can perform to create a machine on UpCloud, wait for it until it\nis up and running, and do some basic provisioning.\n\nWhen you create a machine, you use\n\n    \u003e hicks create \u003csome-hostname\u003e\n\nProvisioning consists of simply uploading a file hierarchy locally stored in\nthe `provision/\u003csome-hostname\u003e` director. In particular, it should contain a\nscript located at `root/bin/provision` that will be run after upload.\n\n## Configure\n\nWhen you ran `cabal install` above, Cabal created an executable `hicks`.\nActually, the source of that executable is `bin/config.hs`. This means you can\neither fork this repository and configure Hicks to your liking by modifying\n`bin/config.hs`, or create a new program depending on the `hicks` package.\n\n## Notes\n\nUpCloud doesn't allow to set a public SSH key automatically when a machine is\ncreated. Instead Hicks will store the root password return by UpCloud in\n`~/.hicks` until the `hicks authorize` command is run. That command will upload\na public SSH key you choose. Further disabling the root password should be done\nin the provisioning script.\n\n## Limitations\n\n- Only UpCloud is supported.\n- Some configuration values are hard-coded (e.g. uk-lon1 or Ubuntu 12.04).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoteed%2Fhicks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoteed%2Fhicks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoteed%2Fhicks/lists"}