{"id":23398801,"url":"https://github.com/mbround18/foundryvtt-docker","last_synced_at":"2025-12-27T14:39:17.293Z","repository":{"id":37072721,"uuid":"261890725","full_name":"mbround18/foundryvtt-docker","owner":"mbround18","description":"A simple docker image for hosting FoundryVTT","archived":false,"fork":false,"pushed_at":"2025-04-05T17:43:33.000Z","size":58248,"stargazers_count":22,"open_issues_count":6,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-05T18:29:54.496Z","etag":null,"topics":["docker","foundry-setup","foundryvtt","ingress","k3s","pwd"],"latest_commit_sha":null,"homepage":"https://youtu.be/5L8Y2-JoGss","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mbround18.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["mbround18"],"patreon":"mbround18","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/MichaelBruno"]}},"created_at":"2020-05-06T22:16:48.000Z","updated_at":"2025-01-19T11:33:11.000Z","dependencies_parsed_at":"2023-12-27T02:25:50.801Z","dependency_job_id":"14d04120-3d91-46ef-9263-8cf7dece1227","html_url":"https://github.com/mbround18/foundryvtt-docker","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbround18%2Ffoundryvtt-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbround18%2Ffoundryvtt-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbround18%2Ffoundryvtt-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbround18%2Ffoundryvtt-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mbround18","download_url":"https://codeload.github.com/mbround18/foundryvtt-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248448063,"owners_count":21105228,"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":["docker","foundry-setup","foundryvtt","ingress","k3s","pwd"],"created_at":"2024-12-22T09:49:28.252Z","updated_at":"2025-12-27T14:39:17.213Z","avatar_url":"https://github.com/mbround18.png","language":"Rust","funding_links":["https://github.com/sponsors/mbround18","https://patreon.com/mbround18","https://paypal.me/MichaelBruno"],"categories":[],"sub_categories":[],"readme":"\u003cimg width=\"500\" src=\"https://repository-images.githubusercontent.com/261890725/ef8c0180-be60-11eb-987b-2e45ff426696\" /\u003e\n\n# FoundryVTT Docker\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://hub.docker.com/r/mbround18/foundryvtt-docker\"\u003e\u003cimg src=\"https://img.shields.io/docker/pulls/mbround18/foundryvtt-docker?style=for-the-badge\" alt=\"Docker Pulls\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/mbround18/foundryvtt-docker/blob/main/LICENSE.md\"\u003e\u003cimg src=\"https://img.shields.io/github/license/mbround18/foundryvtt-docker?style=for-the-badge\" alt=\"License\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/mbround18/foundryvtt-docker/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/mbround18/foundryvtt-docker?style=for-the-badge\" alt=\"GitHub Stars\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## Overview\n\n**⚠️ This docker container requires an active Foundry VTT license. [Purchase one here](https://foundryvtt.com/purchase/).**\n\nA streamlined Docker container for Foundry Virtual Tabletop with an Actix-powered web uploader. This container was designed with simplicity in mind - no credentials to supply, no web driver configurations, and no web automation required.\n\n### Key Features\n\n- 🚀 **Simple Installation** - Easy-to-use web interface for installation\n- 🔒 **Secure** - No credentials stored in the container\n- 🔄 **Persistent Storage** - Mount volumes for data and application\n- 🌐 **Flexible Networking** - Configurable hostname and SSL options\n\n## Quick Start\n\n### Running with Docker\n\n```sh\ndocker run --rm -it \\\n  -p 4444:4444 \\\n  -e HOSTNAME=\"127.0.0.1\" \\\n  -e SSL_PROXY=\"false\" \\\n  -v ${PWD}/foundry/data:/foundrydata \\\n  -v ${PWD}/foundry/app:/foundryvtt \\\n  mbround18/foundryvtt-docker:latest\n```\n\n### Running with Docker Compose\n\nCreate a `docker-compose.yml` file:\n\n```yaml\nversion: \"3\"\nservices:\n  foundry:\n    image: mbround18/foundryvtt-docker:latest\n    ports:\n      - \"4444:4444\"\n    environment:\n      - HOSTNAME=127.0.0.1\n      - SSL_PROXY=false\n    volumes:\n      - ./foundry/data:/foundrydata\n      - ./foundry/app:/foundryvtt\n    restart: unless-stopped\n```\n\nThen run:\n\n```sh\ndocker-compose up -d\n```\n\n## Installation Process\n\n1. Launch the container using one of the methods above\n2. Navigate to your installation URL: [http://localhost:4444](http://localhost:4444/)\n3. In another tab, open your Purchased Licenses page on [foundryvtt.com](https://foundryvtt.com/)\n4. Click the link icon to generate a timed download link\n5. Return to [http://localhost:4444](http://localhost:4444/) and paste the timed URL\n6. Click the submit button and monitor the logs\n7. When complete, navigate to [http://localhost:4444/](http://localhost:4444/) to access the Foundry VTT setup screen\n\n## Environment Variables\n\n| Variable              | Description                             | Default   |\n| --------------------- | --------------------------------------- | --------- |\n| `HOSTNAME`            | The hostname for the server             | `0.0.0.0` |\n| `SSL_PROXY`           | Whether SSL is being handled by a proxy | `false`   |\n| `APPLICATION_PORT`    | The port the application runs on        | `4444`    |\n| `ADMIN_KEY`           | Admin password for Foundry              | _(empty)_ |\n| `MINIFY_STATIC_FILES` | Whether to minify static files          | `true`    |\n\n## Volumes\n\n| Path           | Description                            |\n| -------------- | -------------------------------------- |\n| `/foundrydata` | Foundry user data, worlds, and modules |\n| `/foundryvtt`  | Foundry application files              |\n\n## Troubleshooting\n\n### Common Issues\n\n- **Port already in use**: Change the port mapping in your docker run command (e.g., `-p 8080:4444`)\n- **Permissions errors**: Ensure your mounted volumes have the correct permissions\n- **Download failures**: Verify your Foundry license and that the timed URL is still valid\n\n## Contributing\n\nContributions are welcome! Feel free to open issues or submit pull requests.\n\n## License\n\nThis project is licensed under the [BSD 3-Clause License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbround18%2Ffoundryvtt-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbround18%2Ffoundryvtt-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbround18%2Ffoundryvtt-docker/lists"}