{"id":22057073,"url":"https://github.com/fspoettel/arkhamdb-docker","last_synced_at":"2025-03-23T16:22:45.033Z","repository":{"id":174665750,"uuid":"652213036","full_name":"fspoettel/arkhamdb-docker","owner":"fspoettel","description":"docker compose wrapper to quickly run a local arkhamdb instance.","archived":false,"fork":false,"pushed_at":"2025-01-05T00:12:43.000Z","size":16,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-28T22:31:31.333Z","etag":null,"topics":["arkham-horror","arkham-horror-lcg"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","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/fspoettel.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-11T12:59:42.000Z","updated_at":"2025-01-05T00:12:46.000Z","dependencies_parsed_at":"2025-01-05T01:29:13.624Z","dependency_job_id":null,"html_url":"https://github.com/fspoettel/arkhamdb-docker","commit_stats":null,"previous_names":["fspoettel/arkhamdb-docker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fspoettel%2Farkhamdb-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fspoettel%2Farkhamdb-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fspoettel%2Farkhamdb-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fspoettel%2Farkhamdb-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fspoettel","download_url":"https://codeload.github.com/fspoettel/arkhamdb-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245129005,"owners_count":20565380,"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":["arkham-horror","arkham-horror-lcg"],"created_at":"2024-11-30T16:16:04.626Z","updated_at":"2025-03-23T16:22:45.005Z","avatar_url":"https://github.com/fspoettel.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# arkhamdb-docker\n\n`docker compose` wrapper to quickly run a local [arkhamdb](https://arkhamdb.com/) instance.\n\n# Getting started\n\n\u003e **Warning**  \n\u003e This is tailored to previewing the card database and images. This is not a production-ready setup, nor does it currently support developing arkhamdb itself.\n\n1. install [docker](https://docs.docker.com/engine/install/) and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).\n2. run the following commands in a shell. If your system does not have `make` installed (e.g. on Windows), copy the referenced commands from the `Makefile` and run them manually instead when approriate.\n\n```sh\n# 1. clone this git repository to a folder and change to it.\ngit clone https://github.com/fspoettel/arkhamdb-docker \u0026\u0026 cd arkhamdb-docker\n\n# 2. Clone arkhamdb and arkhamdb-json-data repositories.\n#    If you want to use a fork of the data repository, adjust the command to use your fork.\nmake setup\n\n# 3. Start the containers in one terminal.\ndocker compose up\n\n# 4. In a second terminal, initialize the database.\n#    You only need to do this once on first run.\nmake init-db\n\n# 5. Import card data.\nmake import-cards\n```\n\n✨ You can now access the application at `http://localhost:8000`.\n\n## Updating cards \u0026 images while running\n\nThe folders `\u003crepo\u003e/arkhamdb-json-data` and `\u003crepo\u003e/images` are mounted into the running docker container.\n\nChanges to files in the images folder will be visible in the _\"Browse\"_ view immediately.\n\nIn order to update card data or images in the deck builder view, run `make import-cards` again after making changes and confirm the new card data version in the application UI.\n\n## Accessing the internal database\n\n```\ntype: mysql or mariadb\nhost: 127.0.0.1\nport: 3307\ndatabase: symfony\nuser: symfony_user\npassword: symfony_password\n```\n\n## Creating a user login\n\n1. Register via the application user interface.\n2. Connect to the database with a SQL editor (e.g. [TablePlus](https://tableplus.com/)), using the credentials referenced above.\n3. Navigate to the `users` table and find the record pointing to the user you registered.\n4. Set the `enabled` field to `1`.\n5. You can now login.\n\n## Creating an OAuth app\n\nIf you need to develop against ArkhamDB's OAuth gateway, you can create an oauth client by running the following command. By default, this will create a client with `grant_types` set to `[\"authorization_code\", \"refresh_token\"]`.\n\n```sh\nmake redirect_uri=\"\u003curl\u003e\" name=\"\u003cname\u003e\" create-oauth-app\n```\n\nThe command will output the `client_id` and `client_secret`.\n\nAuthorization endpoint: `http://localhost:8000/oauth/v2/auth`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffspoettel%2Farkhamdb-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffspoettel%2Farkhamdb-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffspoettel%2Farkhamdb-docker/lists"}