{"id":13681243,"url":"https://github.com/org-roam/org-roam-server","last_synced_at":"2025-04-04T17:09:13.292Z","repository":{"id":48479923,"uuid":"260043086","full_name":"org-roam/org-roam-server","owner":"org-roam","description":"A Web Application to Visualize the Org-Roam Database","archived":false,"fork":false,"pushed_at":"2021-08-01T15:54:16.000Z","size":40437,"stargazers_count":637,"open_issues_count":42,"forks_count":50,"subscribers_count":27,"default_branch":"master","last_synced_at":"2025-03-28T16:09:05.594Z","etag":null,"topics":["elisp","emacs","html","javascript","note-taking","org-mode","org-roam","web-application"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/org-roam.png","metadata":{"files":{"readme":"README.md","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}},"created_at":"2020-04-29T20:51:04.000Z","updated_at":"2025-03-15T10:06:18.000Z","dependencies_parsed_at":"2022-09-11T22:01:28.301Z","dependency_job_id":null,"html_url":"https://github.com/org-roam/org-roam-server","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/org-roam%2Forg-roam-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/org-roam","download_url":"https://codeload.github.com/org-roam/org-roam-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247217221,"owners_count":20903009,"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":["elisp","emacs","html","javascript","note-taking","org-mode","org-roam","web-application"],"created_at":"2024-08-02T13:01:28.236Z","updated_at":"2025-04-04T17:09:13.264Z","avatar_url":"https://github.com/org-roam.png","language":"HTML","readme":"org-roam-server\n===================================\n![License](https://img.shields.io/github/license/org-roam/org-roam-server)\n![Release](https://img.shields.io/github/v/release/org-roam/org-roam-server)\n[![MELPA](https://melpa.org/packages/org-roam-server-badge.svg)](https://melpa.org/#/org-roam-server)\n\n![Graph](https://raw.githubusercontent.com/goktug97/org-roam-server/master/org-roam-server.gif)\n\n## Org Roam v2\n\nFor `org-roam v2`, use\n[org-roam-ui](https://github.com/org-roam/org-roam-ui), `org-roam-server`\nonly works with `org-roam v1`\n\n## Installation\n\n`org-roam-server` is on MELPA. You can directly install from there.\n\n```elisp\n(use-package org-roam-server\n  :ensure t\n  :config\n  (setq org-roam-server-host \"127.0.0.1\"\n        org-roam-server-port 8080\n        org-roam-server-authenticate nil\n        org-roam-server-export-inline-images t\n        org-roam-server-serve-files nil\n        org-roam-server-served-file-extensions '(\"pdf\" \"mp4\" \"ogv\")\n        org-roam-server-network-poll t\n        org-roam-server-network-arrows nil\n        org-roam-server-network-label-truncate t\n        org-roam-server-network-label-truncate-length 60\n        org-roam-server-network-label-wrap-length 20))\n```\n\n## Usage\n\nUse `M-x org-roam-server-mode RET` to enable the global mode. \nIt will start a web server on http://127.0.0.1:8080/.\n\nAlthough it will automatically reload if there is a change in the\ndatabase, sometimes it fails to establish a connection. If it does not\nreload after `org-roam-build-cache`, you can do it manually by\nclicking the `reload` button which will reload the data, rebuild the\ngraph and refresh connections.\n\n## Org-Roam Protocol\nThe graph utilizes org-roam protocol which means if you click on one\nof the nodes, it will open the corresponding file in Emacs. For this\nfeature to work, org-roam protocol should be configured in the system.\n\n[Configuring Org-Roam Protocol](https://www.orgroam.com/manual.html#Installation-_00281_0029)\n\nAlso make sure the emacs server is started; `M-x server-start RET`\n\n## License\norg-roam-server is licensed under the MIT License.\n\nFor Javascript and CSS libraries please refer to;\n- https://github.com/jquery/jquery/blob/master/LICENSE.txt\n- https://github.com/visjs/vis-network\n- https://github.com/twbs/bootstrap/blob/master/LICENSE\n- https://github.com/gongzhitaao/orgcss\n- https://github.com/select2/select2\n- https://github.com/minhur/bootstrap-toggle/blob/master/LICENSE\n","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forg-roam%2Forg-roam-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forg-roam%2Forg-roam-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forg-roam%2Forg-roam-server/lists"}