{"id":17486173,"url":"https://github.com/phrb/deploy-org","last_synced_at":"2025-09-02T19:47:14.321Z","repository":{"id":72626026,"uuid":"366123743","full_name":"phrb/deploy-org","owner":"phrb","description":"Scripts to hit the ground running with Emacs, org-mode, and ESS for Reproducible Science on your Linux distribution","archived":false,"fork":false,"pushed_at":"2024-04-26T18:07:47.000Z","size":130,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T16:34:00.577Z","etag":null,"topics":["docker","emacs","emacs-configuration","emacs-ess","emacs-lisp","emacs-speaks-statistics","org-mode","org-mode-configuration"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phrb.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-10T17:26:27.000Z","updated_at":"2024-04-26T18:07:51.000Z","dependencies_parsed_at":"2024-04-26T19:26:07.640Z","dependency_job_id":"5ac3f2a2-9123-432a-bcbb-429434490361","html_url":"https://github.com/phrb/deploy-org","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/phrb%2Fdeploy-org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrb%2Fdeploy-org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrb%2Fdeploy-org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrb%2Fdeploy-org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phrb","download_url":"https://codeload.github.com/phrb/deploy-org/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250266300,"owners_count":21402266,"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":["docker","emacs","emacs-configuration","emacs-ess","emacs-lisp","emacs-speaks-statistics","org-mode","org-mode-configuration"],"created_at":"2024-10-19T02:09:46.110Z","updated_at":"2025-04-22T15:26:26.647Z","avatar_url":"https://github.com/phrb.png","language":"Emacs Lisp","funding_links":[],"categories":[],"sub_categories":[],"readme":"#+TITLE: Deploy Emacs, Org, and ESS\n#+AUTHOR: Pedro Bruel\n#+STARTUP: overview indent\n\n[[http://creativecommons.org/licenses/by/4.0/][https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg]]\n\n[[https://github.com/phrb/deploy-org/actions/workflows/ubuntu_20042_lts.yml][https://github.com/phrb/deploy-org/actions/workflows/ubuntu_20042_lts.yml/badge.svg]]\n[[https://github.com/phrb/deploy-org/actions/workflows/ubuntu_2104.yml][https://github.com/phrb/deploy-org/actions/workflows/ubuntu_2104.yml/badge.svg]]\n[[https://github.com/phrb/deploy-org/actions/workflows/debian_109.yml][https://github.com/phrb/deploy-org/actions/workflows/debian_109.yml/badge.svg]]\n[[https://github.com/phrb/deploy-org/actions/workflows/debian_11.yml][https://github.com/phrb/deploy-org/actions/workflows/debian_11.yml/badge.svg]]\n\nUse the Emacs  configuration files in this repository to  deploy Emacs, org, and\nESS in your system. Tested in different Linux distributions using Docker.\n\n- [[#quickstart][Quickstart]]\n- [[#install-script-and-docker][Install Script and Docker]]\n- [[#contributing][Contributing]]\n- [[#linux-distributions-we-wish-to-support][Linux Distributions we Wish to Support]]\n\n* Quickstart\nTo  install this  configuration in  your system  directly, *backup  your init.el\nfile*, then run:\n\n#+begin_SRC bash :results output :session *Shell* :eval no-export :exports code\ngit clone https://github.com/phrb/deploy-org.git\ncd deploy-org\nsudo ./install/install.sh -i\n./install/install.sh -e -t\n#+end_SRC\n\nYou should  check the Emacs  and org  versions, and you  should see a  =PDF file\nproduced.=  message, indicating  that  org succesfully  compiled  the test  file\n=org/journal/journal.org=   to   =pdf=.    Tests    are   implemented   in   the\n=install/install.sh= script.\n\nThe =install/install.sh= script will attempt to identify your system and run the\ncorrect  shell   script  for  it.    If  it   fails  for  your   system,  please\n[[https://github.com/phrb/deploy-org/issues/new?assignees=\u0026labels=enhancement\u0026template=doesn-t-work-on--my-system-.md\u0026title=Doesn%27t+work+on+%5Bmy+system%5D][submit\nan issue]].\n\n* Install Script and Docker\nThe script's options are:\n\n#+begin_SRC bash :results output :session *Shell* :eval no-export :exports both\n./install/install.sh -h\n#+end_SRC\n\n#+RESULTS:\n: Usage: ./install/install.sh [OPTION]\n: \t-i, --install\tInstall dependencies (requires sudo privileges)\n: \t-e, --emacs\tCopy \"init.el\" to user home [/home/phrb/.emacs.d/]\n: \t-t, --test\tTest user configuration [/home/phrb/.emacs.d/init.el]\n: \t-h, --help\tPrint this message\n\nYou can check the status on your  machine of each supported system using Docker.\nTo check the status for Ubuntu 20.04.2 LTS, for example, run:\n\n#+begin_SRC bash :results output :session *Shell* :eval no-export :exports code\ncd docker/ubuntu_20042_lts\nsudo docker build .\n#+end_SRC\n\n* Contributing\nTo  contribute, please  fork  the  repository, create  a  new  branch with  your\nchanges, and submit a pull request to the =main= branch.\n\n** Adding Support for a New Distribution\nFirst, check  the values of the  =NAME=, =VERSION=, and =PRETTY_NAME=  listed on\nthe =/etc/os-release= file of the distribution you want to add support to:\n\n#+begin_SRC bash :results output :session *Shell* :eval no-export :exports code\nOS_NAME=$(cat /etc/os-release | grep \"^NAME=\" | cut -d= -f2 | cut -d'\"' -f2)\nOS_VERSION=$(cat /etc/os-release | grep \"^VERSION=\" | cut -d= -f2 | cut -d'\"' -f2)\nOS_PRETTY=$(cat /etc/os-release | grep \"^PRETTY_NAME=\" | cut -d= -f2 | cut -d'\"' -f2)\n\necho \"[$OS_NAME] [$OS_VERSION] [$OS_PRETTY]\"\n#+end_SRC\n\nAdd these variables to the =case= structure in the\n[[https://github.com/phrb/deploy-org/blob/main/install/setup_os.sh#L46][check_os_eval]]\nfunction in the\n[[https://github.com/phrb/deploy-org/blob/main/install/setup_os.sh][setup_os.sh]]\nscript. Use the =PRETTY_NAME=, or any other variable in =/etc/os-release=, only\nif =VERSION= is empty. This way, the script can launch the proper function in a\nuser's system.\n\nWrite a function with the configuration  for the target distribution.  If it's a\nDebian-  or   Ubuntu-based  system,   chances  are   the  Ubuntu   functions  in\n[[https://github.com/phrb/deploy-org/blob/main/install/setup_os.sh][setup_os.sh]]\nwill just work.   For example, these are the functions  for Ubuntu 21.04, Debian\n10.9, and Debian 11:\n\n#+begin_SRC bash :results output :session *Shell* :eval no-export :exports code\nfunction ubuntu_2104() {\n    ubuntu_20042_lts\n}\n\nfunction debian_109() {\n    ubuntu_20042_lts\n}\n\nfunction debian_11() {\n    ubuntu_20042_lts\n}\n#+end_SRC\n\nAdd your function call to the =case= structure.\n\nNow, write a =Dockerfile= for your distribution and a corresponding GitHub\naction.  Use the examples in the\n[[https://github.com/phrb/deploy-org/tree/main/docker][docker]] and\n[[https://github.com/phrb/deploy-org/tree/main/.github/workflows][workflows]]\ndirectories as starting points.\n\nMake sure that the tests for your distribution pass, and that your changes don't\nbreak support for any other distribution.\n\nFinally, submit a pull request with the\n[[https://github.com/phrb/deploy-org/blob/main/.github/PULL_REQUEST_TEMPLATE/support_new_distribution.md][Support\nNew Distribution]] template.\n\n** Updating =init.org=\nMake your changes to =init.org=, tangle  blocks to =init.el= with =C-c C-v C-t=,\nand make sure that your changes don't break support for all distributions.\n\nFinally, submit a pull request with the\n[[https://github.com/phrb/deploy-org/blob/main/.github/PULL_REQUEST_TEMPLATE/update_init_org.md][Update\ninit.org]] template.\n\n* Linux Distributions we Wish to Support\nDidn't see yours, or one you want?\n[[https://github.com/phrb/deploy-org/issues/new?assignees=\u0026labels=enhancement\u0026template=doesn-t-work-on--my-system-.md\u0026title=Doesn%27t+work+on+%5Bmy+system%5D][Submit\nan issue]]!\n\n- [ ] Mint\n- [ ] Fedora\n- [ ] NixOS\n- [ ] Guix\n- [ ] Kubuntu\n- [ ] Older Ubuntu versions\n- [ ] Manjaro\n- [ ] Arch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphrb%2Fdeploy-org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphrb%2Fdeploy-org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphrb%2Fdeploy-org/lists"}