{"id":13580180,"url":"https://github.com/sytone/obsidian-remote","last_synced_at":"2025-05-14T11:12:59.307Z","repository":{"id":37410392,"uuid":"469579425","full_name":"sytone/obsidian-remote","owner":"sytone","description":"Run Obsidian.md in a browser via a docker container.","archived":false,"fork":false,"pushed_at":"2025-03-04T06:58:23.000Z","size":274,"stargazers_count":1681,"open_issues_count":50,"forks_count":157,"subscribers_count":28,"default_branch":"main","last_synced_at":"2025-04-04T17:02:15.169Z","etag":null,"topics":["obsidian-md"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sytone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-03-14T04:25:33.000Z","updated_at":"2025-04-04T08:34:26.000Z","dependencies_parsed_at":"2023-11-18T19:23:59.364Z","dependency_job_id":"28796397-58ee-47ad-be03-ca91c055de41","html_url":"https://github.com/sytone/obsidian-remote","commit_stats":{"total_commits":59,"total_committers":8,"mean_commits":7.375,"dds":"0.47457627118644063","last_synced_commit":"516595dd97ed41d1b0a6b208c022845208d755cc"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sytone%2Fobsidian-remote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sytone%2Fobsidian-remote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sytone%2Fobsidian-remote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sytone%2Fobsidian-remote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sytone","download_url":"https://codeload.github.com/sytone/obsidian-remote/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247261592,"owners_count":20910107,"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":["obsidian-md"],"created_at":"2024-08-01T15:01:48.424Z","updated_at":"2025-04-11T21:01:30.897Z","avatar_url":"https://github.com/sytone.png","language":"Dockerfile","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"readme":"# obsidian-remote\n\nThis docker image allows you to run [obsidian](https://obsidian.md/) in docker as a container and access it via your web browser.\n\nUse `http://localhost:8080/` to access it locally, do not expose this to the web unless you secure it and know what you are doing!!\n\n- [Using the Container](#using-the-container)\n  - [Ports](#ports)\n  - [Mapped Volumes](#mapped-volumes)\n  - [Environment Variables](#environment-variables)\n  - [Language Support](#language-support)\n- [Using Docker Compose](#using-docker-compose)\n- [Enabling GIT for the obsidian-git plugin](#enabling-git-for-the-obsidian-git-plugin)\n  - [Docker CLI example](#docker-cli-example)\n- [Reloading Obsidan in the Browser](#reloading-obsidan-in-the-browser)\n- [Setting PUID and PGID](#setting-puid-and-pgid)\n- [Adding missing fonts](#adding-missing-fonts)\n  - [Map font file using Docker CLI](#map-font-file-using-docker-cli)\n  - [Map font file using Docker Compose](#map-font-file-using-docker-compose)\n- [Hosting behind a reverse proxy](#hosting-behind-a-reverse-proxy)\n  - [Example nginx configuration](#example-nginx-configuration)\n- [Hosting behind Nginx Proxy Manager (NPM)](#hosting-behind-nginx-proxy-manager-npm)\n- [Updating Obsidian](#updating-obsidian)\n- [Building locally](#building-locally)\n- [Copy/Paste From External Source](#copypaste-from-external-source)\n\n## Using the Container\n\n### Windows based path\nTo run a interactive version to test it out:\n\n```PowerShell\ndocker run --rm -it `\n  -v D:/ob/vaults:/vaults `\n  -v D:/ob/config:/config `\n  -p 8080:8080 `\n  ghcr.io/sytone/obsidian-remote:latest\n```\n\nTo run it as a daemon in the background:\n\n```PowerShell\ndocker run -d `\n  -v D:/ob/vaults:/vaults `\n  -v D:/ob/config:/config `\n  -p 8080:8080 `\n  ghcr.io/sytone/obsidian-remote:latest\n```\n\nThe ARM container is now avaliable, will look to make this simpler in the future. The ARM imange is on the docker hub and not the github container registry. \n\n```PowerShell\ndocker run -d `\n  -v D:/ob/vaults:/vaults `\n  -v D:/ob/config:/config `\n  -p 8080:8080 `\n  sytone/obsidian-remote:latest\n```\n\n### Linux bash paths\nTo run a interactive version to test it out:\n\n```bash\nmkdir -p ob/{vaults,config}\ndocker run --rm -it \\\n  -v ./ob/vaults:/vaults \\\n  -v ./ob/config:/config \\\n  -p 8080:8080 \\\n  ghcr.io/sytone/obsidian-remote:latest\n```\n\nTo run it as a daemon in the background:\n\n```bash\nmkdir -p ob/{vaults,config}\ndocker run -d \\\n  -v ./ob/vaults:/vaults \\\n  -v ./ob/config:/config \\\n  -p 8080:8080 \\\n  ghcr.io/sytone/obsidian-remote:latest\n```\n\nThe ARM container is now avaliable, will look to make this simpler in the future. The ARM imange is on the docker hub and not the github container registry. \n\n```bash\nmkdir -p ob/{vaults,config}\ndocker run -d \\\n  -v ./ob/vaults:/vaults \\\n  -v ./ob/config:/config \\\n  -p 8080:8080 \\\n  sytone/obsidian-remote:latest\n```\n\n### Ports\n\n| Port  | Description                             |\n| ----- | --------------------------------------- |\n| 8080  | HTTP Obsidian Web Interface             |\n| 8443  | HTTPS Obsidian Web Interface            |\n\n### Mapped Volumes\n\n| Path      | Description                                                               |\n| --------- | ------------------------------------------------------------------------- |\n| `/vaults` | The location on the host for your Obsidian Vaults                         |\n| `/config` | The location to store Obsidan configuration and ssh data for obsidian-git |\n\n### Environment Variables\n\n| Environment Variable | Description                                                                                                                                                                                                                         |\n| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| PUID                 | Set the user ID for the container user. `911` by default.                                                                                                                                                                           |\n| PGID                 | Set the group ID for the continer user. `911` by default.                                                                                                                                                                           |\n| TZ                   | Set the Time Zone for the container, should match your TZ. `Etc/UTC` by default. See [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for valid options.                              |\n| DOCKER_MODS          | Use to add mods to the container like git. E.g. `DOCKER_MODS=linuxserver/mods:universal-git` See [Docker Mods](https://github.com/linuxserver/docker-mods) for details.                                                             |\n| INSTALL_PACKAGES     | Use to add package for the container like language pack. E.g. `INSTALL_PACKAGES=fonts-noto-cjk fonts-noto-extra` And the docker mod `linuxserver/mods:universal-package-install` is required.                                       |\n| KEYBOARD             | Used to se the keyboard being used for input. E.g. `KEYBOARD=en-us-qwerty` or `KEYBOARD=de-de-qwertz` a list of other possible values (not tested) can be found at \u003chttps://github.com/linuxserver/docker-digikam#keyboard-layouts\u003e |\n| CUSTOM_PORT          | Internal port the container listens on for http if it needs to be swapped from the default 3000.                                                                                                                                    |\n| CUSTOM_HTTPS_PORT    | Internal port the container listens on for https if it needs to be swapped from the default 3001.                                                                                                                                   |\n| CUSTOM_USER          | HTTP Basic auth username, abc is default.                                                                                                                                                                                           |\n| PASSWORD             | HTTP Basic auth password, abc is default. If unset there will be no auth                                                                                                                                                            |\n| SUBFOLDER            | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/`                                                                                                                              |\n| TITLE                | The page title displayed on the web browser, default \"KasmVNC Client\".                                                                                                                                                              |\n| FM_HOME              | This is the home directory (landing) for the file manager, default \"/config\".                                                                                                                                                       |\n\n### Language Support\n\nTo show the other languages, add the mod `linuxserver/mods:universal-package-install` and add the language pack. E.g. `INSTALL_PACKAGES=fonts-noto-cjk fonts-noto-extra` to support CJK (Chinese Japanese Korean).\n\nTo type other language in the browser you should enable the **IME Input Mode** in the side panel.\n\n![Settings IME Input Mode](./assets/IMEInputMode.png)\n\n## Using Docker Compose\n\n```YAML\nservices:\n  obsidian:\n    image: 'ghcr.io/sytone/obsidian-remote:latest'\n    container_name: obsidian-remote\n    restart: unless-stopped\n    ports:\n      - 8080:8080\n      - 8443:8443\n    volumes:\n      - /home/obsidian/vaults:/vaults\n      - /home/obsidian/config:/config\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=America/Los_Angeles\n      - DOCKER_MODS=linuxserver/mods:universal-git\n      - CUSTOM_PORT=\"8080\"\n      - CUSTOM_HTTPS_PORT=\"8443\" \n      - CUSTOM_USER=\"\"\n      - PASSWORD=\"\"\n      - SUBFOLDER=\"\"\n```\n\n## Enabling GIT for the obsidian-git plugin\n\nThis container uses the base images from linuxserver.io. This means you can the linuxserver.io mods. To add support for git add the `DOCKER_MODS` environment variable like so `DOCKER_MODS=linuxserver/mods:universal-git`.\n\n### Docker CLI example\n\n```PowerShell\ndocker run -d `\n  -v D:/ob/vaults:/vaults `\n  -v D:/ob/config:/config `\n  -p 8080:8080 `\n  -e DOCKER_MODS=linuxserver/mods:universal-git `\n  ghcr.io/sytone/obsidian-remote:latest\n```\n\n## Reloading Obsidan in the Browser\n\nIf you make changes to plugins or do updates that need to have obsidian restarted, instead of having to stop and start the docker container you can just close the Obsidian UI and right click to show the menus and reopen it. Here is a short clip showing how to do it.\n\n![Reloading Obsidian in the Browser](./assets/ReloadExample.gif)\n\n## Setting PUID and PGID\n\nTo set PUID and PGID use the follow environment variables on the command line, by default the IDs are 911/911\n\n```PowerShell\ndocker run --rm -it `\n  -v D:/ob/vaults:/vaults `\n  -v D:/ob/config:/config `\n  -e PUID=1000 `\n  -e PGID=1000 `\n  -p 8080:8080 `\n  ghcr.io/sytone/obsidian-remote:latest\n```\n\nOr, if you use docker-compose, add them to the environment: section:\n\n```yaml\nenvironment:\n  - PUID=1000\n  - PGID=1000\n```\n\nIt is most likely that you will use the id of yourself, which can be obtained by running the command below. The two values you will be interested in are the uid and gid.\n\n```powershell\nid $user\n```\n\n## Adding missing fonts\n\nThanks to @aaron-jang for this example.\n\nDownload the font of the language that you want to use in Obsidian and add it to the volume as shown below.\n\n### Map font file using Docker CLI\n\n```PowerShell\n  -v {downloaded font directory}:/usr/share/fonts/truetype/{font name}\n```\n\n### Map font file using Docker Compose\n\n```PowerShell\n    volumes:\n      - {downloaded font directory}:/usr/share/fonts/truetype/{font name}\n```\n\n## Hosting behind a reverse proxy\n\nIf you wish to do that **please make sure you are securing it in some way!**. You also need to ensure **websocket** support is enabled.\n\n### Example nginx configuration\n\nThis is an example, I recommend a SSL based proxy and some sort of authentication.\n\n```\nserver {\n  set $forward_scheme http;\n  set $server         \"10.10.10.10\";\n  set $port           8080;\n\n  listen 80;\n  server_name ob.mycooldomain.com;\n  proxy_set_header Upgrade $http_upgrade;\n  proxy_set_header Connection $http_connection;\n  proxy_http_version 1.1;\n  access_log /data/logs/ob_access.log proxy;\n  error_log /data/logs/ob_error.log warn;\n  location / {\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection $http_connection;\n    proxy_http_version 1.1;\n    # Proxy!\n    add_header       X-Served-By $host;\n    proxy_set_header Host $host;\n    proxy_set_header X-Forwarded-Scheme $scheme;\n    proxy_set_header X-Forwarded-Proto  $scheme;\n    proxy_set_header X-Forwarded-For    $remote_addr;\n    proxy_set_header X-Real-IP          $remote_addr;\n    proxy_pass       $forward_scheme://$server:$port$request_uri;\n  }\n}\n```\n\n## Hosting behind Nginx Proxy Manager (NPM)\n\nThanks to @fahrenhe1t for this example.\n\nIf you install obsidian-remote in Docker, you can proxy it through [Nginx Proxy Manager](https://nginxproxymanager.com/) (NPM - running on the same Docker instance), and use an access list to provide user authentication. The obsidian-remote container would have to be on the same network as Nginx Proxy Manager. If you don't expose the IP external to the container, authentication would be forced through NPM:\n\n```yaml\nservices:\n  obsidian:\n    image: 'ghcr.io/sytone/obsidian-remote:latest'\n    container_name: obsidian-remote\n    restart: unless-stopped\n    ports:\n      - 8080 #only exposes port internally to the container\n    volumes:\n      - /home/obsidian/vaults:/vaults\n      - /home/obsidian/config:/config\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=America/Los_Angeles\n      - DOCKER_MODS=linuxserver/mods:universal-git\nnetworks:\n  default:\n    name: \u003cyour nginx proxy manager network\u003e\n    external: true\n```\n\nCreate a proxy host in NPM pointing to the \"obsidian-remote:8080\" container, choose your domain name, use a LetsEncrypt SSL certificate, enable WebSockets. This video talks about it: [Nginx Proxy Manager - ACCESS LIST protection for internal services](https://www.youtube.com/watch?v=G9voYZejH48)\n\n## Updating Obsidian\n\nBy default obsidian will update itself in the container. If you recreate the container you will have to do the update again. This repo will be updated periodically to keep up with the latest version of Obsidian.\n\n## Building locally\n\nTo build and use it locally run the following commands:\n\n```PowerShell\ndocker build --pull --rm `\n  -f \"Dockerfile\" `\n  -t obsidian-remote:latest `\n  \".\"\n```\n\nTo run the localy build image:\n\n```PowerShell\ndocker run --rm -it `\n  -v D:/ob/vaults:/vaults `\n  -v D:/ob/config:/config `\n  -p 8080:8080 `\n  obsidian-remote:latest bash\n```\n\n\n## Copy/Paste From External Source\n\nClick on the circle to the left side of your browser window. In there you will find a textbox for updating the remote clipboard or copying from it.\n\n![image](https://user-images.githubusercontent.com/1399443/202805847-a87e2c7c-a5c6-4dea-bbae-4b25b4b5866a.png)\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsytone%2Fobsidian-remote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsytone%2Fobsidian-remote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsytone%2Fobsidian-remote/lists"}