{"id":20441771,"url":"https://github.com/micromdm/squirrel","last_synced_at":"2025-04-12T23:32:54.750Z","repository":{"id":48113507,"uuid":"60929302","full_name":"micromdm/squirrel","owner":"micromdm","description":"A server just for munki","archived":false,"fork":false,"pushed_at":"2021-06-16T15:17:17.000Z","size":4224,"stargazers_count":88,"open_issues_count":2,"forks_count":13,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-26T17:41:54.934Z","etag":null,"topics":["macadmins","munki"],"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/micromdm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","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":"2016-06-11T21:49:02.000Z","updated_at":"2025-01-17T01:35:27.000Z","dependencies_parsed_at":"2022-08-12T18:50:46.697Z","dependency_job_id":null,"html_url":"https://github.com/micromdm/squirrel","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micromdm%2Fsquirrel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micromdm%2Fsquirrel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micromdm%2Fsquirrel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micromdm%2Fsquirrel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/micromdm","download_url":"https://codeload.github.com/micromdm/squirrel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647257,"owners_count":21139081,"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":["macadmins","munki"],"created_at":"2024-11-15T09:34:43.854Z","updated_at":"2025-04-12T23:32:54.731Z","avatar_url":"https://github.com/micromdm.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"squirrel.png\" alt=\"squirrel\"/\u003e\u003cbr/\u003e\n\u003c/p\u003e\nSquirrel is a Simple HTTPs server for munki.\nSee the [legacy](https://github.com/micromdm/squirrel/tree/legacy) branch for the API implementation. I plan on adding it back with Munki v3 support.\n\n# Features\n\n* [X] **Automatic HTTPS** - squirrel provides a built in Let's Encrypt Client.\n* [X] Basic Authentication - Basic Auth for munki repo\n* [X] Use cloud storage as a repo backend.\n* [X] Structured request logging with JSON or [logfmt](https://brandur.org/logfmt) output.\n\n# Install\nDownload the [latest release](https://github.com/micromdm/squirrel/releases/latest) from the release page. \n\n# Quickstart\n\n```\nsquirrel serve -repo=/path/to/munki_repo -tls-domain=munki.corp.example.com --basic-auth=CHANGEME\n```\n\n`-repo` flag must be set to the path of a munki repository.  \n`-tls-domain` flag must be set to the domain of your munki repo. This value is used by squirrel to obtain new TLS certificates.  \n`-basic-auth` flag must be set to a password which will be used for authentication to the munki repo.  \n\nOnce the server starts, you will see a prompt which prints the correct Authorization header that you need to add to your munki configuration profile.\nThe help text is convenient, but you might want to disable it if you're capturing logs somewhere. Use `-no-help` flag to disable printing the help text.\n\nExample:\n```\nAuthorization: Basic c3F1aXJyZWw6Q0hBTkdFTUU=\n```\n\nSee `squirrel help` for full usage.\n\n# Keep the process running with systemd\n\nFor help with systemd see the example/systemd folder.\n\n# Enroll mac hosts:\n\nFor help enrolling macOS hosts, check out the example/profile folder.\n\n# Repo provider\nSquirrel has pluggable storage for munki repo, specified with the `-provider` flag. \nThe default provider is set to `filesystem`, which will expect a local path to munki repo.\n\nOther supported providers are `s3` and `gcs`(google cloud storage).\n\nSee the provider specific sections below for how to connect to S3 or GCS.\n\n## S3 provider\n\nFirst, export the necessary credentials of a IAM user and region as environment variables. (You can also use the ~/.aws/credentials config file as described [here](https://github.com/aws/aws-sdk-go#aws-shared-config-file-awsconfig))\n\n```\nexport AWS_ACCESS_KEY_ID=AKID1234567890\nexport AWS_SECRET_ACCESS_KEY=MY-SECRET-KEY\nexport AWS_REGION=us-east-1\n```\n\nNow serve squirrel. Use the AWS bucket name for the `-repo` flag.\n```\nsquirrel serve -repo=awsbucketname -tls-domain=munki.corp.example.com --basic-auth=CHANGEME -provider=s3\n```\n\nTo try the config locally on port 8080, you can run\n\n```\nsquirrel serve -basic-auth=\"CHANGEME\" -repo=awsbucketname -tls=false -provider=s3\n```\nWhich will make your munki repo available at `http://localhost:8080/repo/`.\nGo to `http://localhost:8080/repo/catalogs/all` to get a list of available credentials.\n\n## Google Cloud Storage Provider \n\nTo use squirrel with GCS, you'll need a GCP service account file. \n```\nsquirrel serve \\\n    -repo=gcsbucketname \\\n    -tls-domain=munki.corp.example.com \\\n    -basic-auth=CHANGEME \\\n    -provider=gcs \\\n    -gcs-credentials /Users/groob/Downloads/groob-gcs-credentials.json \n```\n\n\nTo try the config locally on port 8080, you can run\n\n```\nsquirrel serve \\\n    -repo=gcsbucketname \\\n    -tls=false \\\n    -basic-auth=CHANGEME \\\n    -provider=gcs \\\n    -gcs-credentials /Users/groob/Downloads/groob-gcs-credentials.json \n```\n\nWhich will make your munki repo available at `http://localhost:8080/repo/`.\nGo to `http://localhost:8080/repo/catalogs/all` to get a list of available credentials.\n\n---\nsquirrel icon by [Agne Alesiute](https://thenounproject.com/search/?q=squirrel\u0026i=190468) from the [Noun Project](https://thenounproject.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicromdm%2Fsquirrel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicromdm%2Fsquirrel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicromdm%2Fsquirrel/lists"}