{"id":21643930,"url":"https://github.com/application-research/estuary-docker","last_synced_at":"2025-04-11T18:21:44.504Z","repository":{"id":40418234,"uuid":"467734256","full_name":"application-research/estuary-docker","owner":"application-research","description":"Estuary provisioning using docker","archived":false,"fork":false,"pushed_at":"2022-10-24T23:45:16.000Z","size":36,"stargazers_count":2,"open_issues_count":7,"forks_count":6,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-11T18:21:40.467Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/application-research.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-09T01:23:59.000Z","updated_at":"2024-08-10T13:51:26.000Z","dependencies_parsed_at":"2023-01-19T21:18:32.995Z","dependency_job_id":null,"html_url":"https://github.com/application-research/estuary-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/application-research%2Festuary-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/application-research%2Festuary-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/application-research%2Festuary-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/application-research%2Festuary-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/application-research","download_url":"https://codeload.github.com/application-research/estuary-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248456388,"owners_count":21106607,"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-25T05:36:57.139Z","updated_at":"2025-04-11T18:21:44.474Z","avatar_url":"https://github.com/application-research.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Estuary Main, Shuttle and WWW docker containers repository\n\nA  automation script to run a main estuary node, frontend and estuary shuttles.\n\n*Work in Progress*\n\n# Install the following\n\n- docker\n- docker hub desktop (optional)\n\n## Component Diagram and How it works\n\n![image](https://user-images.githubusercontent.com/4479171/157783874-9186f9d3-512c-4c82-9a85-9cfc8cd65fd3.png)\n\n\n## Run a Local Estuary, Shuttle and Website with docker-compose\n\n1. Create a local dns mapping in `/etc/hosts`\n\n```\n127.0.0.1 estuary-main\n```\n\nFor users using linux shell, you can also run the following script to add the host (you'll be prompt with your machine/local password).\n\n```\nsudo -- sh -c -e \"echo '\\n127.0.0.1   estuary-main' \u003e\u003e /etc/hosts\";\n```\n\n2. Start up the stack with `docker-compose`\n```\ndocker-compose up\n```\n\n3. Capture the AuthToken (Estuary Token) from the output:\n\n```\n...\nestuary-shuttle_1  | Hostname: estuary-main:3004\nestuary-shuttle_1  | Shuttle Token: SECRETf5487ef1-0393-42df-a3bb-516416af8a0bSECRET\nestuary-shuttle_1  | Shuttle Handle: SHUTTLEf80a12ca-502d-4cdc-a282-830dbe0c6acbHANDLE\nestuary-shuttle_1  | Estuary Token: ESTf469c66f-9e15-4a67-bba9-a97bedfa0352ARY\n...\n```\n\n4. Navigate to `http://estuary-main:4444` and login with the AuthToken captured in the previous step.\n\n## Run estuary-main\n```\ncd estuary-main\n./run-main.sh\n```\nRunning the command above will launch a docker image with the estuary node and return an `Auth Token`\n\n## Run multiple estuary-shuttles\n```\ncd estuary-shuttle\n./run-shuttles.sh --num-of-shuttles 3 --estuary-api-key \u003cAuth Token from run-main.sh\u003e --estuary-host estuary-main:3004\n# sample: ./run-shuttles.sh --num-of-shuttles 3 --estuary-api-key ESTe2813e65-f177-4192-b601-1e55ca4e930bARY --estuary-host estuary-main:3004\n```\n\nThe command above will launch three containers with different handles and tokens, which will all connect to the estuary-main via `--estuary-host` flag\n## Run estuary frontend \n```\ncd estuary-www\n./run-www.sh --estuary-api-key \u003cAuth Token from run-main.sh\u003e --estuary-host estuary-main:3004\n# sample: ./run-www.sh --estuary-api-key EST6de30581-92bf-4e2d-a218-5233a456baa5ARY --estuary-host estuary-main:3004\n```\n\nThe frontend will be connected to the estuary-main.\n## Test your setup\n\n### Test adding/pinning a new object\n```\n## estuary-main:3004 or localhost:3004\ncurl -X POST http://localhost:3004/pinning/pins -d '{ \"name\": \"1882818-2021-nature-videos.zip\", \"cid\": \"bafybeidj7c2e3daplalccukbps4eze7473gyshspev76xi4sjfmfkuaofe\" }' -H \"Content-Type: application/json\" -H \"Authorization: Bearer \u003cAuth Token\u003e\"\n\n```\n\n### Test listing all pinned objects\n```\n## estuary-main:3004 or localhost:3004\ncurl -X GET http://localhost:3004/pinning/pins -H \"Content-Type: application/json\" -H \"Authorization: Bearer \u003cAuth Token\u003e\"\n```\n\n### Test Estuary frontend\n\nGo to [localhost:4444](localhost:4444) and login with your API key.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplication-research%2Festuary-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapplication-research%2Festuary-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplication-research%2Festuary-docker/lists"}