Skip to content

Getting Started

Henning Weiss edited this page Aug 16, 2014 · 5 revisions

mOrgAnd works by synchronizing with a Git repository. This requires you to have all your org files under Git version control. You should also have a server where you host your repository. Github offers private repositories for a small monthly fee.

  • mOrgAnd does not use org-mobile-push/pull in any way. The contents of your repository should be your actual org files
  • mOrgAnd will update the contents of your org files if you edit them in mOrgAnd and synchronize them. I would consider this fairly safe, as your files are under version control, but please make sure to create backups anyway!
  • Remember that this is alpha grade software. Don’t trust it with important data (…yet)

mOrgAnd

  1. Install mOrgAnd from the Releases page
  2. Start synchronization. mOrgAnd will download the Github wiki pages to your phone that serve as a demonstration

If you want to use your own Git repository, do the following:

  1. Press the menu button and go to “Settings->Git”
  2. Click “Git local repository path” and create a new folder
  3. Set up everything under the “remote” section to suit your setup
  4. (Optional) Copy your private ssh key file to your phone (doesn’t matter where) and select it by clicking “Private ssh key file”. mOrgAnd will copy the key file to its private data storage and the key can be safely deleted
  5. Start synchronization

Creating a new Git repository

To set up a new repository, install Git on your computer and execute the following commands in your org directory:

  1. git init
  2. git add -A
  3. git commit -m MESSAGE
  4. git remote add origin URL_TO_YOUR_GIT_REPO
  5. git push -u origin master

Emacs (optional)

To enable automatic commits, pushes and pulls in Emacs I use the following: hdw_org_git.el

Documentation

Development

Clone this wiki locally