{"id":13566606,"url":"https://github.com/dockette/expose","last_synced_at":"2025-03-01T18:45:00.362Z","repository":{"id":70424512,"uuid":"377872447","full_name":"dockette/expose","owner":"dockette","description":"🐳  Expose local sites via secure tunnels using Expose app written in PHP. ","archived":false,"fork":false,"pushed_at":"2021-08-09T13:28:47.000Z","size":14,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-12T09:47:41.839Z","etag":null,"topics":["dockette","expose","ngrok","on-premise","server","tunnel","tunneling"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/dockette.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,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":["f3l1x"]}},"created_at":"2021-06-17T15:10:16.000Z","updated_at":"2022-01-01T23:39:59.000Z","dependencies_parsed_at":"2023-03-05T11:45:32.532Z","dependency_job_id":null,"html_url":"https://github.com/dockette/expose","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/dockette%2Fexpose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockette%2Fexpose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockette%2Fexpose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dockette%2Fexpose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dockette","download_url":"https://codeload.github.com/dockette/expose/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241411473,"owners_count":19958746,"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":["dockette","expose","ngrok","on-premise","server","tunnel","tunneling"],"created_at":"2024-08-01T13:02:12.955Z","updated_at":"2025-03-01T18:45:00.334Z","avatar_url":"https://github.com/dockette.png","language":"PHP","readme":"\u003ch1 align=center\u003eDockette / Expose\u003c/h1\u003e\n\n\u003cp align=center\u003e\n    Expose local sites via secure tunnels using Expose app written in PHP.\n\u003c/p\u003e\n\n\u003cp align=center\u003e\n🕹 \u003ca href=\"https://f3l1x.io\"\u003ef3l1x.io\u003c/a\u003e | 💻 \u003ca href=\"https://github.com/f3l1x\"\u003ef3l1x\u003c/a\u003e | 🐦 \u003ca href=\"https://twitter.com/xf3l1x\"\u003e@xf3l1x\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=center\u003e\n    \u003ca href=\"https://hub.docker.com/r/dockette/expose/\"\u003e\u003cimg src=\"https://img.shields.io/docker/stars/dockette/expose.svg?style=flat-square\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://hub.docker.com/r/dockette/expose/\"\u003e\u003cimg src=\"https://img.shields.io/docker/pulls/dockette/expose.svg?style=flat-square\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://bit.ly/ctteg\"\u003e\u003cimg src=\"https://img.shields.io/gitter/room/contributte/contributte.svg?style=flat-square\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/sponsors/f3l1x\"\u003e\u003cimg src=\"https://img.shields.io/badge/sponsor-me-brightgreen?style=flat-square\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n-----\n\n## Usage\n\n### Server\n\nFastest way:\n\n```\ndocker run \\\n    -it \\\n    --rm \\\n    -p 80:80 \\\n    -e EXPOSE_HOST=yourdomain.dev \\\n    -e EXPOSE_PORT=80 \\\n    dockette/expose\n```\n\nPersistent way:\n\n```\ndocker run \\\n    -it \\\n    --rm \\\n    -p 80:80 \\\n    -v $(pwd)/data:/data\n    dockette/expose\n```\n\n### Client\n\n```\ndocker run \\\n    -it \\\n    --rm \\\n    --network=host \\\n    -e EXPOSE_HOST=yourdomain.dev \\\n    -e EXPOSE_PORT=80 \\\n    dockette/expose \\\n    share \\\n    --subdomain=foo \\\n    http://0.0.0.0:5000\n```\n\n\u003e Use http://host.docker.internal:5000 on OSX.\n\n## Documentation\n\nYou can easily setup Expose via environment variables. This is list of default values.\n\n```\n- EXPOSE_HOST=localhost         # expose domain\n- EXPOSE_PORT=8000              # expose port\n- EXPOSE_USERNAME=dockette      # dashboard user name\n- EXPOSE_PASSWORD=expose        # dashboard user password\n- EXPOSE_TOKEN=                 # expose token\n- EXPOSE_ADMIN=admin            # dashboard subdomain\n- EXPOSE_DB=/data/expose.db     # expose database (for users)\n```\n\nFor more details, take a look at Expose's [official documentation](https://expose.beyondco.de/docs/server/starting-the-server).\n\n**How to test it?**\n\n```\n# Server\ndocker run -it --rm -p 8000:8000 -e EXPOSE_HOST=expose.local dockette/expose\n```\n\n```\necho \"Hello world\" \u003e\u003e index.php\n\n# Application\nphp -S http://0.0.0.0:5000 index.php\n```\n\n```\n# Tunnel (Unix)\ndocker run -it --rm --network=host -e EXPOSE_HOST=expose.local dockette/expose share --subdomain=foo http://0.0.0.0:5000\n```\n\n\u003e Use http://host.docker.internal:5000 on OSX.\n\n## Development\n\nSee [how to contribute](https://contributte.org/contributing.html) to this package.\n\nThis package is currently maintaining by these authors.\n\n\u003ca href=\"https://github.com/f3l1x\"\u003e\n    \u003cimg width=\"80\" height=\"80\" src=\"https://avatars2.githubusercontent.com/u/538058?v=3\u0026s=80\"\u003e\n\u003c/a\u003e\n\n-----\n\nConsider to [support](https://github.com/sponsors/f3l1x) **f3l1x**. Also thank you for using this package.\n","funding_links":["https://github.com/sponsors/f3l1x"],"categories":["PHP"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdockette%2Fexpose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdockette%2Fexpose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdockette%2Fexpose/lists"}