{"id":31836760,"url":"https://github.com/veupathdb/vdi-compose-stack","last_synced_at":"2026-02-18T12:01:24.751Z","repository":{"id":316471456,"uuid":"1062742606","full_name":"VEuPathDB/vdi-compose-stack","owner":"VEuPathDB","description":"VDI service stack compose files and configuration.","archived":false,"fork":false,"pushed_at":"2026-01-30T15:23:24.000Z","size":118,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-31T08:18:45.475Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VEuPathDB.png","metadata":{"files":{"readme":"readme.adoc","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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-23T17:00:41.000Z","updated_at":"2026-01-30T15:23:28.000Z","dependencies_parsed_at":"2025-09-24T21:08:33.242Z","dependency_job_id":"dcb5ffe8-ebbd-4d10-b3e5-dac2944b793e","html_url":"https://github.com/VEuPathDB/vdi-compose-stack","commit_stats":null,"previous_names":["veupathdb/vdi-compose-stack"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/VEuPathDB/vdi-compose-stack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VEuPathDB%2Fvdi-compose-stack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VEuPathDB%2Fvdi-compose-stack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VEuPathDB%2Fvdi-compose-stack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VEuPathDB%2Fvdi-compose-stack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VEuPathDB","download_url":"https://codeload.github.com/VEuPathDB/vdi-compose-stack/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VEuPathDB%2Fvdi-compose-stack/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29578140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T08:38:15.585Z","status":"ssl_error","status_checked_at":"2026-02-18T08:38:14.917Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2025-10-12T01:58:07.432Z","updated_at":"2026-02-18T12:01:24.739Z","avatar_url":"https://github.com/VEuPathDB.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"= VDI Service Docker Compose Stack\n:toc:\n:source-highlighter: highlight.js\n:highlightjs-theme: github\n:compose-ref: https://docs.docker.com/reference/cli/docker/compose\n:gh-org-url: https://github.com/VEuPathDB\n\n== Local Development\n\nFor developer use, this repository includes makefiles with shortcuts for\nperforming the standard docker compose operations, including a full-stack\nrebuild.\n\n=== Quick Start\n\n==== Using Remote App DB\n\n. Navigate to link:dev/local-with-remote-appdb/[].\n. From that directory run `make prep-stack` to create a copy of the appropriate\n  stack config file and environment file. +\n_The stack config copy will be named `stack-config.yml`._ +\n_The environment file copy will be named `.env`._\n. Edit the `.env` file and fill in the `APP_DB_*` environment variables with the\n  actual target DB details.\n. Follow the `ssh-compose` section of the\n  {gh-org-url}/util-infra-dev-tools?tab=readme-ov-file#ssh-compose[util-infra-dev-tools]\n  readme to create a `docker-compose.ssh.yml` file.\n. Run `make up` to start up the VDI stack.\n. Run `make logs` to tail the stack logs and ensure the SSH tunnels\n  are successfully established.\n\n\n==== Fully Local\n\n. Navigate to link:dev/fully-local/[].\n. From that directory run `make prep-stack` to create a copy of the appropriate\nstack config file and environment file. +\n_The stack config copy will be named `stack-config.yml`._ +\n_The environment file copy will be named `.env`._\n. Run `make up` to start the VDI stack.\n\n\n=== Make Targets\n\n'{BLANK}'::\n+\n--\nSimply running `make` with no target prints out all the available targets.\n--\n\n==== Common Targets\n\nprep-stack::\nCopies the files necessary to run a VDI stack into the working directory that\n`make` was called from.\n\nbuild::\nPerforms a full service stack build from source.  This will used cached build\nlayers from the host machine if they are available.  Use `OPTIONS` to change\nthat behavior if desired.\n\nbuild-db::\nBuilds only the local Postgres App DB image.\n\nup::\nRuns {compose-ref}/up[`docker compose up`], expecting a `.env` file in the\nproject root directory by default.\n\ndown::\nRuns {compose-ref}/down[`docker compose down`].\n\nstart::\nRuns {compose-ref}/start[`docker compose start`].\n\nstop::\nRuns {compose-ref}/stop[`docker compose stop`].\n\nrestart::\nRuns {compose-ref}/restart[`docker compose restart`].\n\nlogs::\nRuns {compose-ref}/logs[`docker compose logs`].\n\nlog-service::\nRuns {compose-ref}/logs[`docker compose logs service`], printing out only the\nlogs from the HTTP REST server.\n\nlog-\\{plugin-name}::\n+\n--\nPrints logs from only the specific target plugin container.\n\n.Example\n[source,shell]\n----\n# Show only the biom container logs\nmake log-biom\n----\n--\n\ncmd::\nPrints docker compose commands.  May be combined with input parameters to\ngenerate custom commands to run outside of make.\n\n=== Compose Parameters\n\n`ENV_FILE`::\nPath to the environment file to use with the docker compose command.\n+\nDefault value is `${PWD}/.env`\n+\n.Example\n[source, shell]\n----\n# runs docker compose top\nmake compose ENV_FILE=\"/home/me/my/top/secret/variables.env\"\n----\n\n`COMPOSE_FILES`::\nPaths to additional docker compose config files that should be included in the\ncompose command.\n+\n.Example\n[source, shell]\n----\n# adds docker-compose.ssh.yml to the compose file list\nmake compose COMPOSE_FILES=docker-compose.ssh.yml\n----\n\n`COMMAND`::\nDocker compose command to execute.\n+\nDefault value is dependent on make target, for the `compose` target, the default\nvalue is `--help`\n+\n.Example\n[source, shell]\n----\n# runs docker compose top\nmake compose COMMAND=\"top\"\n----\n\n\n`OPTIONS`::\nAdditional CLI options that will be passed to the specific compose command.\n+\n.Example\n[source, shell]\n----\n# remove volumes as part of the compose down command\nmake down OPTIONS=-v\n----\n\n\n`SERVICES`::\nLimit the compose command to the provided target services.\n+\n.Example\n[source, shell]\n----\n# (re)create the wrangler and noop plugin containers\nmake up SERVICES=\"plugin-wrangler plugin-noop\"\n----\n\n\n\n== License\n\nCopyright 2025 VEuPathDB\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use\nthis file except in compliance with the License. You may obtain a copy of the\nLicense at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied.\n\nSee the License for the specific language governing permissions and limitations\nunder the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveupathdb%2Fvdi-compose-stack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveupathdb%2Fvdi-compose-stack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveupathdb%2Fvdi-compose-stack/lists"}