{"id":21883095,"url":"https://github.com/rainmark/opengrok-restful","last_synced_at":"2025-04-15T06:08:31.538Z","repository":{"id":97604447,"uuid":"312538302","full_name":"RainMark/opengrok-restful","owner":"RainMark","description":"🔥 OpenGrok RESTful interface for Emacs 🔥","archived":false,"fork":false,"pushed_at":"2025-01-07T14:18:23.000Z","size":46190,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T06:08:24.101Z","etag":null,"topics":["emacs","emacs-lisp","opengrok","spacemacs"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RainMark.png","metadata":{"files":{"readme":"README.org","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,"governance":null}},"created_at":"2020-11-13T10:01:30.000Z","updated_at":"2025-01-07T14:19:08.000Z","dependencies_parsed_at":"2023-11-15T11:28:29.475Z","dependency_job_id":"10fb093b-5ca3-435f-b781-5a1dca1101b6","html_url":"https://github.com/RainMark/opengrok-restful","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RainMark%2Fopengrok-restful","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RainMark%2Fopengrok-restful/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RainMark%2Fopengrok-restful/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RainMark%2Fopengrok-restful/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RainMark","download_url":"https://codeload.github.com/RainMark/opengrok-restful/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249016627,"owners_count":21198833,"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":["emacs","emacs-lisp","opengrok","spacemacs"],"created_at":"2024-11-28T09:39:15.302Z","updated_at":"2025-04-15T06:08:31.533Z","avatar_url":"https://github.com/RainMark.png","language":"Emacs Lisp","funding_links":[],"categories":[],"sub_categories":[],"readme":"** opengrok-restful\n\n*** Setup opengrok (v1.3)\n\n    - Start opengrok server and limit the cpu usage of opengrok indexer.\n    - Period of automatic mirroring/reindexing (10min).\n    - The volume mounted to ~/Projects should contain the projects you want to make searchable.\n    - Open http://127.0.0.1:8080 to enjoy.\n\n    #+begin_src shell\n    $ sudo docker run -d --cpus=\"1.0\" \\\n        --name opengrok \\\n        -p 8080:8080/tcp \\\n        -e REINDEX=\"10\" \\\n        -v ~/Projects:/opengrok/src/ \\\n        opengrok/docker:1.3\n    #+end_src\n\n    - You can avoid to sync source code from upstream.\n\n    #+begin_src shell\n    $ sudo docker exec -it opengrok sed -i 's/opengrok-mirror/#opengrok-mirror/g' /scripts/index.sh\n    #+end_src\n\n    - You can manually trigger an reindex using docker exec.\n\n    #+begin_src shell\n    $ sudo docker exec -it opengrok /scripts/index.sh\n    #+end_src\n\n*** Setup opengrok (v1.13)\n\n    #+begin_src shell\n    $ docker run -d --name opengrok -p 8080:8080/tcp -e NOMIRROR=1 -e SYNC_PERIOD_MINUTES=0 -v /Users/bytedance/opengrok:/opengrok/src/ opengrok/docker:1.13 tail -f /dev/null\n    $ docker exec -it opengrok bash\n    \u003e apt update \u0026\u0026 apt install -y vim\n    \u003e vim /scripts/start.py # Comment out the -H parameter (appears twice) and the --noIndex parameter in the code\n    \u003e source /venv/bin/activate\n    \u003e nohup env INDEXER_OPT=\"-I *.cpp -I *.hpp -I *.h -I *.c\" python /scripts/start.py \u0026\n    #+end_src\n\n*** Setup opengrok-restful\n\n    #+begin_src shell\n    $ git clone https://github.com/RainMark/opengrok-restful.git ~/opengrok-restful\n    #+end_src\n\n    - Emacs config.\n\n    #+begin_src elisp\n    ;; opengrok-restful\n    (add-to-list 'load-path \"~/opengrok-restful\")\n    (require 'opengrok-restful)\n    (setq opengrok-restful-source-directory \"~/Projects\")\n    (global-set-key (kbd \"M-d\") 'opengrok-restful-lookup-def)\n    (global-set-key (kbd \"M-f\") 'opengrok-restful-lookup-full)\n    (global-set-key (kbd \"M-s\") 'opengrok-restful-lookup-symbol)\n    (global-set-key (kbd \"M-p\") 'opengrok-restful-lookup-path)\n    #+end_src\n\n    - When you lookup symbol with opengrok-restful, Input nothing to lookup all projects that indexed, Input 'c' to lookup current project.\n\n    [[./opengrok-restful.gif]]\n\n    [[./opengrok-restful.png]]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainmark%2Fopengrok-restful","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frainmark%2Fopengrok-restful","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainmark%2Fopengrok-restful/lists"}