{"id":19610610,"url":"https://github.com/accosine/agaragar","last_synced_at":"2026-04-06T01:35:12.831Z","repository":{"id":78463044,"uuid":"80769596","full_name":"accosine/agaragar","owner":"accosine","description":null,"archived":false,"fork":false,"pushed_at":"2017-03-20T17:14:49.000Z","size":71,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-03T14:38:33.712Z","etag":null,"topics":["alpine","api","couchdb","docker","docker-compose","elasticsearch","hapi","haproxy","letsencrypt","logstash","node","react","redis"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/accosine.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":"2017-02-02T21:17:39.000Z","updated_at":"2018-03-29T13:21:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"244ac400-1477-458a-b44d-82610f06e5f0","html_url":"https://github.com/accosine/agaragar","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/accosine/agaragar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/accosine%2Fagaragar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/accosine%2Fagaragar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/accosine%2Fagaragar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/accosine%2Fagaragar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/accosine","download_url":"https://codeload.github.com/accosine/agaragar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/accosine%2Fagaragar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31456662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"ssl_error","status_checked_at":"2026-04-05T21:22:51.943Z","response_time":75,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["alpine","api","couchdb","docker","docker-compose","elasticsearch","hapi","haproxy","letsencrypt","logstash","node","react","redis"],"created_at":"2024-11-11T10:31:08.989Z","updated_at":"2026-04-06T01:35:12.817Z","avatar_url":"https://github.com/accosine.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Poltergeist\nA containered, open source, API first JAM Stack for building content management\nsystems - based on Docker, node.js, Redis, CouchDB, elasticsearch and HAProxy.\n\n## Setup\nThe only thing you need on your machine to get started is docker and\ndocker-compose.\n\n### Development Setup\n1.) Copy `example.env` to `.env` and change settings accordingly.\n\n2.) Create the necessary docker volumes:\n\n    docker volume create --name=poltergeist_couchdb\n    docker volume create --name=poltergeist_redis\n    docker volume create --name=poltergeist_elasticsearch\n    docker volume create --name=poltergeist_prodcerts\n\n\n3.) Generate self-signed SSL certificate for development:\n\n    docker-compose -f docker-compose.admin.yml run certgen-dev\n\n\n4.) Start the whole stack in development mode (and detach):\n\n    docker-compose up --build -d\n\n\n5.) Setup CouchDB in development:\n\n    docker-compose -f docker-compose.admin.yml run setup-couchdb-dev\n\n\n6.) Populate Database\nIf you have Markdown files with yaml frontmatter, you can directly import them\nas documents into CouchDB.\nCreate the folder that will hold your Markdown documents:\n\n    mkdir -p volumes/couchdb/import/articles\n    mkdir -p volumes/couchdb/import/pages\n\n\nCopy Markdown files into the corresponding folder and import them (this only\nworks locally in development mode):\n\n    docker-compose -f docker-compose.admin.yml run import-couchdb-articles\n    docker-compose -f docker-compose.admin.yml run import-couchdb-pages\n\n7.) If you're on a Linux flavour, you have to raise the virtual memory max map\ncount and disable `Transparent Huge Pages` on the Docker host:\n\n    sysctl -w vm.max_map_count=262144\n    echo never \u003e /sys/kernel/mm/transparent_hugepage/enabled\n\n\n8.) Install node.js packages via Lerna:\n\n    docker-compose -f docker-compose.admin.yml run setup-api-dev\n\n\n9.) Restart the whole stack with everything set up:\n\n    docker-compose down \u0026\u0026 docker-compose up --build\n\n\n10.) Make the stack locally accessible via (sub-)domain in your hosts file:\n\n    127.0.0.1 example.com\n    127.0.0.1 db.example.com\n    127.0.0.1 search.example.com\n    127.0.0.1 api.example.com\n\n- TODO: dnsmasq setup\n\n---\n\n### Production Setup\n\n0.) Set A-Records for the following subdomains: `api`, `db`,`search` and let\nthem propagate.\n\n1.) Copy `example.env` to `.env` and change settings accordingly.\n\n2.) Create the necessary docker volumes:\n\n    docker volume create --name=poltergeist_couchdb\n    docker volume create --name=poltergeist_redis\n    docker volume create --name=poltergeist_elasticsearch\n    docker volume create --name=poltergeist_prodcerts\n\n\n3.) Generate valid SSL certificate via Letsencrypt:\n\n    docker-compose -f docker-compose.admin.yml run -p 80:80 certgen-prod\n\n4.) Start the whole stack in production mode:\n\n    docker-compose -f docker-compose.yml -f docker-compose.prod.yml up --build\n\n\n5.) Setup CouchDB:\nThis only works with proper DNS record for your domain and working SSL\ncertificates (even if self-signed):\n\n    docker-compose -f docker-compose.admin.yml run setup-couchdb-prod\n\n\n6.) Populate Database\nIf you have Markdown files with yaml frontmatter, you can directly import them\nas documents into CouchDB.\nCreate the folder that will hold your Markdown documents:\n\n    mkdir -p volumes/couchdb/import\n\n\nCopy Markdown files into the import folder and import them (this only works\nlocally):\n\n    docker-compose -f docker-compose.admin.yml run import-couchdb-data\n\n\n7.) If you're on a Linux flavour, you have to raise the virtual memory max map\ncount and disable \"Transparent Huge Pages\" on the Docker host:\n\n    sysctl -w vm.max_map_count=262144\n    echo never \u003e /sys/kernel/mm/transparent_hugepage/enabled\n\n\n8.) Install node.js packages via Lerna:\n\n    docker-compose -f docker-compose.admin.yml run setup-api-dev\n\n\n9.) Restart the whole stack with everything set up:\n\n    docker-compose -f docker-compose.yml -f docker-compose.prod.yml up --build\n\n\n## System service\nMove the poltergeist repository to /opt/poltergeist or make a symlink.\nInstall systemd services to start the poltergeist stack on boot:\n\n    cp setup/systemd/poltergeist* /etc/systemd/system/\n    systemctl enable poltergeist.service\n    systemctl enable poltergeist-certgen-prod.timer\n    systemctl daemon-reload\n    systemctl start poltergeist.service\n    systemctl start poltergeist-certgen-prod.timer\n\n\nCheck if your stytemd timer is working correctly (this will periodically renew\nSSL certifiates if necessary via Letsencrypt):\n\n    systemctl list-timers --all\n\n\n# Backups\nMake a backup of the databases and certificates:\n\n    docker-compose -f docker-compose.admin.yml run backup-couchdb\n    docker-compose -f docker-compose.admin.yml run backup-redis\n    docker-compose -f docker-compose.admin.yml run backup-elasticsearch\n    docker-compose -f docker-compose.admin.yml run backup-prodcerts\n\n\nRestore a previously made backup:\n\n    docker-compose -f docker-compose.admin.yml run restore-couchdb\n    docker-compose -f docker-compose.admin.yml run restore-redis\n    docker-compose -f docker-compose.admin.yml run restore-elasticsearch\n    docker-compose -f docker-compose.admin.yml run restore-prodcerts\n\n\n## MacOS\nDelete all .DS_Store files:\n\n    find . -type f -name '*.DS_Store' -ls -delete\n\n\nAttach to \"Docker for Mac\" Socket (press Enter to login)\n\n    screen ~/Library/Containers/com.docker.docker/Data/com.docker.driver.amd64-linux/tty\n\n\n## Software stack\n- Docker (1.13.0 (15072))\n- Docker-Compose (1.10.0, build 4bd6f1a)\n- node.js (Docker image: node:7.6.0-alpine)\n- Lerna (2.0.0-beta.38)\n- hapi (15.2.0)\n- HAProxy (Docker image: haproxy:1.7.2-alpine)\n- CouchDB (Docker image: klaemo/couchdb:2.0.0)\n- Redis (Docker image: redis:3.2.7-alpine)\n- elasticsearch (Docker image: docker.elastic.co/elasticsearch/elasticsearch:5.2.1)\n- logstash (Docker image: logstash:5.2.1-alpine)\n\n\n## Prior art (kinda)\n- https://www.contentful.com\n- https://prismic.io\n- https://cosmicjs.com\n- https://getdirectus.com\n- https://getcockpit.com\n- http://osmek.com\n\n## License\n\nPoltergeist is BSD licensed.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faccosine%2Fagaragar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faccosine%2Fagaragar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faccosine%2Fagaragar/lists"}