{"id":20420312,"url":"https://github.com/grantmacken/alpine-xqerl","last_synced_at":"2026-06-08T10:02:20.380Z","repository":{"id":52922406,"uuid":"204086905","full_name":"grantmacken/alpine-xqerl","owner":"grantmacken","description":"dockerize xqerl","archived":false,"fork":false,"pushed_at":"2021-09-05T21:48:39.000Z","size":253,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-05T04:29:40.241Z","etag":null,"topics":["cli","docker-image","otp-applications","xpath","xqerl","xquery"],"latest_commit_sha":null,"homepage":"","language":"Makefile","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/grantmacken.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":"2019-08-24T00:15:40.000Z","updated_at":"2021-09-05T21:48:41.000Z","dependencies_parsed_at":"2022-08-24T02:01:02.052Z","dependency_job_id":null,"html_url":"https://github.com/grantmacken/alpine-xqerl","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/grantmacken/alpine-xqerl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmacken%2Falpine-xqerl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmacken%2Falpine-xqerl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmacken%2Falpine-xqerl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmacken%2Falpine-xqerl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grantmacken","download_url":"https://codeload.github.com/grantmacken/alpine-xqerl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmacken%2Falpine-xqerl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34057158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cli","docker-image","otp-applications","xpath","xqerl","xquery"],"created_at":"2024-11-15T06:42:26.877Z","updated_at":"2026-06-08T10:02:20.360Z","avatar_url":"https://github.com/grantmacken.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [alpine-xqerl](https://github.com/grantmacken/alpine-xqerl)\n\n[![](https://github.com/grantmacken/alpine-xqerl/workflows/CI/badge.svg)](https://github.com/grantmacken/alpine-xqerl/actions)\n\n [xqerl](https://zadean.github.io/xqerl)\n maintained by \n [Zachary Dean](https://github.com/zadean),\n is an Erlang XQuery 3.1 Processor and XML Database.\n\n## Recent Updates\n - [x] built from [alpine 3.14.2](https://hub.docker.com/_/alpine) docker OS\n - [x] [OTP 24.0.6](https://hub.docker.com/_/erlang) latest [release](https://github.com/erlang/otp/releases)\n - [x] built from latest xqerl \n [merge commit](https://api.github.com/repos/zadean/xqerl/git/commits/1a94833e996435495922346010ce918b4b0717f2)\n - [x] uses config values in .env file to set some xqerl.config values. This is of interest only if you wish to build the image\n   yourself. In xqerl repo the  `./config/xqerl.config`, item `environment_access` is set to `false`. Our docker image\n   is built with this var set to `true`. If you want to keep the default, clone this repo and in the file `.env` set `CONFIG_ENVIRONMENT_ACCESS=false`, then run `make` to build the image.\n  - [x] removed docker-compose example file instead you can clone this repo and use `make up`\n  - [x] in container added tzdata for timezone resolution. Set your timezone in the .env file. \n  - [x] bin dir contains a [terminal cli for xqerl](./docs/images/rec-xq-db.svg)\n\n## TODO:  \n - [ ] doc pages\n\n\n[xqerl](https://zadean.github.io/xqerl) is in constant development, \nso I have also tagged images with the xqerl [main](https://github.com/zadean/xqerl) git commit sha.  These tagged images are available on [dockerhub](https://hub.docker.com/r/grantmacken/alpine-xqerl/tags)\nIf you are testing or setting up a xqerl development environment, then it is advisable to use the latest sha tagged images.\nAny [xqerl issues](https://zadean.github.io/xqerl/issues) when developing with xqerl can be communicated back to the [repo owner](https://github.com/zadean) using the commit sha as a reference.\n\n```\ndocker pull grantmacken/alpine-xqerl:1a94833e996435495922346010ce918b4b0717f2\n```\n\nOther pre-built images are available on [dockerhub](https://hub.docker.com/r/grantmacken/alpine-xqerl)\nThe latest xqerl docker release is also on [github packages](https://github.com/grantmacken/alpine-xqerl/packages)\n\nOn [dockerhub](https://hub.docker.com/r/grantmacken/alpine-xqerl) I have provided two images\n \n1. interactive erlang shell: This image is a clone of xqerl repo with the entry point via `rebar3 shell` \n2. production release: a smallish internet deploy image\n\n## Notes: working with xqerl\n\nThis repo provides some helper **tools**, \nto help with you to work with xqerl\n\n1. *Makefile* at the project root.\n2. *xq* which is a bash cli executable in the 'bin' directory. \n3. a src directory, which is an example xqerl project layout.\n\n## Shell: A Fat Playground Desktop Image\n\n```\nmake run-shell\n```\n\nThis starts xqerl from ENTRYPOINT `rebar3 shell` to pop you into\nthe *interactive* erlang shell. \nThe container contains a clone the  [xqerl repo](https://zadean.github.io/xqerl) so from here you should be able to follow the \n[Getting Started](https://github.com/zadean/xqerl/blob/master/docs/src/GettingStarted.md)\ntutorial from section 4 onwards.\n\n## Smallish Internet Deployable Image\n\nThis is a smallish (about 42MB) 'deploy' image, where a binary executable boots the xqerl environment,\n\n Prior to running the container, I suggest you create a docker **network** and some docker **volumes**.\nCreating a prior *network*, allows a running xqerl container to join a network rather than creating a new network each time the container is started.\n\nCreated docker *volumes* allow us to persist our 'xquery code' and any data in the 'xqerl database'. \nWe could mount bind, to a local directory, but created named volumes are more portable.\nOnce the docker network and volumes are in place we can run the container.\n\nIn the Makefile I have an `make up` and `make down` target,\nwhich sets this up for you using some config vars from the .env file\n\nThe docker run time instance includes \n* A container run name: 'xq'\n* A container hostname: 'xq'\n* Two persistent docker volumes \n    1. A volume named 'data' which holds the xqerl database data\n    2. A volume name 'code' which holds the xqerl compiled xQuery  beam files \n* joining docker network named 'wrk'\n* uses docker host environment variable `TZ` for setting local timezones\n* exposes published port: 8081\n\nOnce the container is up running, you can issue \ndocker exec commands, like this ...\n\n```\ndocker exec xq xqerl eval 'application:ensure_all_started(xqerl).'\ndocker exec xq xqerl eval \"xqerl:run(\\\"xs:token('cats'), xs:string('dogs'), true() \\\").\"\n```\n\nThe above is not to very useful, so to really get started the thing first things you need to check out, \nis the [xqerl documentation](https://zadean.github.io/xqerl/).\nThere you will learn how how to ...\n- compile your xquery files so they run on the [OTP beam](https://en.wikipedia.org/wiki/BEAM_(Erlang_virtual_machine))\n- store update and retrieve data from the xqerl database\n- use restXQ to create a restful web facing applications and APIs\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrantmacken%2Falpine-xqerl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrantmacken%2Falpine-xqerl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrantmacken%2Falpine-xqerl/lists"}