{"id":20162826,"url":"https://github.com/gamgaroo/esmeralda","last_synced_at":"2026-05-09T07:36:28.901Z","repository":{"id":33947436,"uuid":"132637986","full_name":"gamgaroo/Esmeralda","owner":"gamgaroo","description":"ASP.NET Core Web App for hosting Unity3D WebGL builds with support of Continuous Delivery via Unity Cloud Webhooks.","archived":false,"fork":false,"pushed_at":"2022-12-08T00:50:48.000Z","size":39,"stargazers_count":1,"open_issues_count":7,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-13T14:19:51.730Z","etag":null,"topics":["asp-net-core","continuous-delivery","continuous-deployment","hosting","notifications","slack","unity","unity-cloud-webhook","unity3d","webgl"],"latest_commit_sha":null,"homepage":"","language":"C#","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/gamgaroo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-08T16:45:39.000Z","updated_at":"2022-02-12T12:38:24.000Z","dependencies_parsed_at":"2023-01-15T03:32:17.319Z","dependency_job_id":null,"html_url":"https://github.com/gamgaroo/Esmeralda","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamgaroo%2FEsmeralda","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamgaroo%2FEsmeralda/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamgaroo%2FEsmeralda/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamgaroo%2FEsmeralda/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gamgaroo","download_url":"https://codeload.github.com/gamgaroo/Esmeralda/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241600518,"owners_count":19988715,"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":["asp-net-core","continuous-delivery","continuous-deployment","hosting","notifications","slack","unity","unity-cloud-webhook","unity3d","webgl"],"created_at":"2024-11-14T00:27:04.898Z","updated_at":"2026-05-09T07:36:23.873Z","avatar_url":"https://github.com/gamgaroo.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Esmeralda\nASP.NET Core Web App for hosting Unity3D WebGL builds with support of Continuous Delivery via Unity Cloud Webhooks.\n\n[![GitHub release](https://img.shields.io/github/release/Gamgaroo/Esmeralda/all.svg)](https://GitHub.com/Gamgaroo/Esmeralda/releases/)\n[![Build Status](https://travis-ci.org/Gamgaroo/Esmeralda.svg?branch=master)](https://travis-ci.org/Gamgaroo/Esmeralda)\n[![BCH compliance](https://bettercodehub.com/edge/badge/Gamgaroo/Esmeralda?branch=master)](https://bettercodehub.com/)\n\n## Getting Started\n### Host on IIS\n1) Configure *Settings/unity.json* with your Unity Cloud API Key in Unity section\n2) Create a Unity Cloud webhook with URL http://{esmeralda-url}/api/builds\n3) Start new build on Unity Cloud\n4) After build completion Unity Cloud will push a notification to Esmeralda\n5) After deployment completion the build will be accessible on http://{esmeralda-url}/index.html\n\n### Run in Docker container\n1) Run docker container\n```\ndocker run -e Unity:ApiKey=\"API_KEY\" -p 80:80 gamgaroo/esmeralda\n```\n2) Create a Unity Cloud webhook with URL http://{esmeralda-url}/api/builds\n3) Start new build on Unity Cloud\n4) After build completion Unity Cloud will push a notification to Esmeralda\n5) After deployment completion the build will be accessible on http://{esmeralda-url}/index.html\n\n### Environment variables\n\n**Required**\n\nUnity:ApiKey\n\n**Optional**\n\nAdmin:Username (Default: admin)\n\nAdmin:Password (Default: admin)\n\nSlack:Enable (Default: _false_)\n\nSlack:WebhookUrl (Defalt: _WEBHOOK_URL_)\n\nUnity:CloudUrl (Default: _[https://build-api.cloud.unity3d.com](https://build-api.cloud.unity3d.com)_)\n\n**_It is highly recommended that you change the default Username and Password values for security reasons_.**\n\n**Example**\n```\ndocker run -e Admin.Username=\"admin\" -e Admin.Password=\"password\" -e Unity:ApiKey=\"API_KEY\" -e Slack:Enable=true -e Slack:WebhookUrl=\"WEBHOOK_URL\" -p 80:80 gamgaroo/esmeralda\n```\n\n## Settings API\nYou can configure Esmeralda using settings API:\n\nYou can _GET_ or _POST_ on _http://{esmeralda-url}/api/settings_\n\n```json\n{\n    \"unity\": {\n        \"apiKey\": \"API_KEY\",\n        \"cloudUrl\": \"https://build-api.cloud.unity3d.com\"\n    },\n    \"slack\": {\n        \"enable\": false,\n        \"webhookUrl\": \"WEBHOOK_URL\"\n    }\n}\n```\nAPI is secured with [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).\n\n## Notifications\nYou can enable Slack notifications. App notify on Deployment Start, Deployment Success and Deployment Failure.\n\n1) Create Slack webhook on Slack admin page\n2) Configure *Settings/slack.json* with your WebhookUrl in Slack section and set Enable to true\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgamgaroo%2Fesmeralda","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgamgaroo%2Fesmeralda","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgamgaroo%2Fesmeralda/lists"}