{"id":18109727,"url":"https://github.com/l4rm4nd/Obsidian-Gitsync-Perlite","last_synced_at":"2025-03-29T16:31:02.463Z","repository":{"id":101184623,"uuid":"607407049","full_name":"l4rm4nd/Obsidian-Gitsync-Perlite","owner":"l4rm4nd","description":"Docker container to continuously sync Obsidian markdown notes from GitHub and publish it for the webs ","archived":false,"fork":false,"pushed_at":"2024-10-29T15:48:08.000Z","size":84,"stargazers_count":84,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T12:01:34.890Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","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/l4rm4nd.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-02-27T22:59:26.000Z","updated_at":"2025-03-24T17:19:03.000Z","dependencies_parsed_at":"2024-11-08T06:37:05.055Z","dependency_job_id":null,"html_url":"https://github.com/l4rm4nd/Obsidian-Gitsync-Perlite","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l4rm4nd%2FObsidian-Gitsync-Perlite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l4rm4nd%2FObsidian-Gitsync-Perlite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l4rm4nd%2FObsidian-Gitsync-Perlite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/l4rm4nd%2FObsidian-Gitsync-Perlite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/l4rm4nd","download_url":"https://codeload.github.com/l4rm4nd/Obsidian-Gitsync-Perlite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246213584,"owners_count":20741757,"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":[],"created_at":"2024-11-01T00:01:59.257Z","updated_at":"2025-03-29T16:31:02.177Z","avatar_url":"https://github.com/l4rm4nd.png","language":"PHP","funding_links":[],"categories":["🐳 Project List"],"sub_categories":["Wikis \u0026 Knowledge Base"],"readme":"# Obsidian-Gitsync-Perlite\n\nDocker container to continuously sync Obsidian markdown notes from a GitHub repository and publish it for the webs.\n\nOfficial Perlite [demo here](https://perlite.secure77.de/).\n\n![image](https://user-images.githubusercontent.com/21357789/221725827-d14001aa-0030-4b5e-b509-cf826227c5b0.png)\n\n# Usage\n\n````\n# clone this repository\ngit clone https://github.com/l4rm4nd/Obsidian-Mkdocs-Gitsync\ncd Obsidian-Mkdocs-Gitsync\n\n# adjust `docker-compose.yml` to your needs:\n# 1. add your to be synced GitHub repo at env variable `GIT_SYNC_REPO`\n# 2. add your GitHub username at env variable `GIT_SYNC_USERNAME` - only if your repo is private\n# 3. add GitHub access token at env variable `GIT_SYNC_PASSWORD` - only if your repo is private\n# 4. add your GitHub repo name at env variable `HIDE_FOLDERS`\n\n# fix permissions; may have to be run a second time after starting the container\nsudo chmod -R 777 repository/\nsudo chown -R 1000:1000 repository/\n\n# start the container\ndocker compose up -d\n````\n\nThen browse http://127.0.0.1:8888 to inspect your markdown notes. May combine with a reverse proxy such as Traefik and publish securely to the interwebs. Enjoy!\n\n# Customization\n\nIf you want to change the default notes path/name `Demo`, you also have to adjust the volume mappings for the perlite service too. So if your to be synced GitHub repo is called `Obsidian_Notes`, adjust the compose file's service Perlite as follows:\n\n````\nservices:\n  perlite:\n    image: sec77/perlite:latest\n    container_name: perlite\n    restart: unless-stopped\n    environment:\n      - NOTES_PATH=Obsidian_Notes # \u003c-- adjusted with custom repo name\n      - HIDE_FOLDERS=docs,private,trash\n      - LINE_BREAKS=true\n    volumes:\n      - ./repository/root:/var/www/perlite/Obsidian_Notes:ro # \u003c-- adjusted with custom repo name\n````\n\nIf you want to adjust the website's title, please adjust the `index.php` file that is bind mounted into the Perlite container. The following line is relevant:\n\n````\n13   $title = 'Obsidian-Gitsync-Perlite';\n````\n\n# Links \u0026 Images\n\nTo correctly display images and links you have to adjust your Obsidian settings slightly. \n\nIn detail, you have to enable relative path links. Please follow the instructions [here](https://github.com/secure-77/Perlite/wiki/03---Perlite-Settings#required-settings).\n\n# Acknowledgement\n\nMany thanks to the original devs:\n\n- ❤️ [secure-77](https://github.com/secure-77) for [Perlite](https://github.com/secure-77/Perlite)\n- ❤️ [kubernetes](https://github.com/kubernetes) for [git-sync](https://github.com/kubernetes/git-sync)\n\n# Repo Statistics\n\n![Alt](https://repobeats.axiom.co/api/embed/9f8de6ac8c10d682c08f9dafdf062711f182654c.svg \"Repobeats analytics image\")\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fl4rm4nd%2FObsidian-Gitsync-Perlite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fl4rm4nd%2FObsidian-Gitsync-Perlite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fl4rm4nd%2FObsidian-Gitsync-Perlite/lists"}