organice documentation

Table of Contents

organice - /'ɔ:gənaɪz/

organice organizes Org files nicely!

1 General

Community chat: #organice on IRC Freenode, or #organice:matrix.org on Matrix

Code repository: https://github.com/200ok-ch/organice

1.1 What does this project do?

organice is an implementation of Org mode without the dependency of Emacs. It is built for mobile and desktop browsers and syncs with Dropbox, Google Drive and WebDAV.

At 200ok, we run an instance of organice at https://organice.200ok.ch, which is open for anyone to use! organice does not have a back-end (it's just a front-end application, which uses either Dropbox, Google Drive or WebDAV as back-end storage). We don't store any kind of data on our servers - we also don't use analytics on organice.200ok.ch.

screenshot-overview.png

1.2 Why is this project useful

Emacs is great, but it's desktop software. For users who want to access or edit their Org mode files whilst on the go, organice is a great choice.

1.3 Introduction

If you prefer a video to some text, we've got you covered! For EmacsConf 2019, we've created a 10 minute introductory video into the rationale and usability of organice.

screenshot-introduction.png

You can watch it on:

2 Installation

organice is a web application. You can use it from any browser. On iOS and Android, you can install organice to your homescreen. When started from there, it will run in full-screen and add some offline capabilities.

Installing to the homescreen on:

  • iOS:

    Open organice in Mobile Safari. Tap the "share" button and select "Add to Home Screen".

  • Android:

    The exact procedure may differ depending on your browser and Android version. If you discover improvements to the following procedure, please let us know!

    First open the organice web page in your mobile browser.

    • On Chrome, tap the "menu" button (three vertically stacked dots) and select "Add to homescreen".
    • On Firefox, tap the home icon with the plus sign inside it which is immediately to the right of the URL in the address bar.
    • Other browsers may have a similar procedure to one of these.

    At this point, most browsers will present a popup banner with the option to "Add to homescreen" or "Install".

    If you want the organice app icon on your home screen to jump to a specific .org file, and/or if you want multiple app icons on the home screen to jump to different files, things can get a bit more tricky. For instance, Chrome only offers "Add to homescreen" the first time; once it has been added, the option changes to "Open organice". Firefox allows creation of multiple home screen icons, but when opening any of these, organice does not jump directly to the specific file which was open when the icon was created.

    Therefore if you want multiple organice bookmark icons on your homescreen which jump straight to particular files, you may have better luck using another technique. For example, you can use a third-party program called "Open Link With…". Once that's installed, from Chrome, visit the page in organice you want to make a homescreen icon for, then tap the "menu" button again, select "Share…", and then "Add To Home", then "organice". Once it's added, your home launcher may allow you to change the visible icon to the organice icon, or whatever other icon you choose.

3 Usage

3.1 Current restrictions/expectations of organice

"Current" means we're working hard on removing the following restrictions and expectations.

  • organice understands only a few in-buffer settings (see Supported in-buffer configuration)
    • Other in-buffer settings are imported and re-exported but are not editable with organice.
  • Other content before the first headline is imported and re-exported, but invisible and currently not editable with organice.
  • After potential in-buffer settings, your Org file has to begin with a headline.

Apart from these restrictions, organice is very robust in reading and editing your Org file and not breaking any of it. We're having users with 10'000 lines in their files including all kinds of native Org functionality - and even these files work just fine in organice!

Generally, when working with distributed Org files, we're recommending to put them under version control and to check for bugs and racing conditions between clients.

Please file an issue if you find additional restrictions, expectations or bugs that you you wouldn’t have expected.

3.1.1 Background information

organice has a custom parser for Org files. It works quite fine and has unit tests to prove it. One of the quality goals for the parser is that when it parses and re-exports an Org file, it should not change the original file. Not seeing unrelated diffs is important for the productivity of the user. It sounds trivial, but lots of alternative products do not live up to this expectation.

Writing a parser for a complex syntax like Org mode in custom code is hard. Therefore, we are in the process of implementing a proper EBNF based parser and a set of tests behind that. If you're interested, please check it out: https://github.com/200ok-ch/org-parser

The strategy we're using with regards to the parser is this:

  • Keep improving the existing custom parser for new features and make bug fixes as long as the new one isn't ready.
  • In parallel, work on the new one until there is feature parity between both parsers.
  • When the new one is finished, integrate it into organice.

3.2 Progressive Web App / Offline Support

organice can run as a PWA (Progressive Web App) - see the installation instructions and does have offline support. From your home screen, organice will start up in full screen and it will use a Service Worker to cache the application. On a desktop browser, the Service Worker will be used automatically. This is implemented using the Create React App Progressive Web App functionality which enables the following features:

  • All static assets are cached so that organice loads fast on subsequent visits, regardless of network connectivity.
  • Updates are downloaded in the background.
  • organice works regardless of network state, even if offline.
  • On mobile devices, organice can be added directly to the user's home screen, app icon and all.

Following that, if you start modifying your Org file when offline, organice will recognize that you are offline and queue up the synchronization until you are online again.

organice also understands when it's local Org file is outdated compared to the upstream file and will ask you want you want to do - pull the one from the synchronization back-end, push the one from organice or cancel. This happens when you made changes to your file on at least two machines at the same time without synchronizing them in the meantime. For this, we recommend to put your Org file under version control which is the idiomatic solution for changing text based files on multiple machines in parallel.

4 Customization

4.1 General

Since organice implements Org mode, one might wonder if we plan to duplicate the Emacs configuration strategy. In Emacs Org mode, there's more than 500 variables for customization - and on top of that, there's often two ways to configure things:

  1. Using elisp
  2. Using in-buffer settings

Modifying Org behavior using elisp (variables) is certainly mighty and powerful. However, the goal of organice is not to clone Emacs in full. In fact, it could be argued that this is not possible. Emacs being a LISP machine has inherent power that cannot be brought to a web application. Instead, the goal is to make Org mode accessible on smartphones and for non-Emacs users. For both use-cases, elisp variable configuration is not an idiomatic or ergonomic option.

organice implements this customization strategy:

  • Use in-buffer settings where appropriate
  • Build custom and mobile friendly user interfaces where appropriate

4.2 Supported in-buffer configuration

4.2.1 In-buffer settings

  • #+TODO
  • #+TYP_TODO

4.2.2 #+STARTUP: options

  • nologrepeat: Do not record when reinstating repeating item

4.2.3 Drawer properties

  • logrepeat and nologrepeat: Whether to record when reinstating repeating item
:PROPERTIES:
:LOGGING:  logrepeat
:END:

4.3 Other customizations

For some customizations, organice exposes a mobile friendly user interface. Please find them in the 'settings' view (cogs icon in the header on the right).

screenshot-settings.png

5 Development

organice is built with React and Redux. It was bootstrapped with Create React App. The tests are written with React Testing Library. The internal data structures are written as immutable persistent data collections with the Immutable library.

5.1 Prerequisites

You will need a version of the Node.js engine installed which fulfills the requirement stated in package.json. If you don't already have this installed, it is recommended to install it via nvm. The organice repository already contains an .nvmrc file, so once you have nvm installed, the following commands should be sufficient:

nvm install
nvm use

5.2 Setup

To install the necessary packages, run:

yarn install

To test against your own Dropbox account, you'll need to create a .env file by copying .env.sample to just .env.

cp .env.sample .env

Running the application:

yarn start

Running the tests:

yarn test

For searching the Org file, there's a grammar for the search clause. It's written in pegjs. Generating the parser code happens automatically on yarn start|build|test. When working on the parser, you can manually generate it with:

./bin/compile_search_parser.sh

5.3 Testing

When you're developing a new feature and you want to manually test it, it's best to check it out in a Desktop browser and on your smartphone. This is how you do that:

5.3.1 Desktop

Run the application with yarn start which will open organice in your configured default browser. Alternatively, visit http://localhost:3000 in the browser of your choice.

5.3.2 Smartphone

There are multiple options on how you can connect from your smartphone to your computer running organice.

When running organice with yarn start, it will show you all the IPs that the application server is bound to. One will be local to your computer, one will be on your network (if you're connected to a LAN or Wifi, that is).

If your smartphone has access to the same network, you can access it with the given IP address and port number.

If your new feature doesn't require a synchronization back-end, just open the sample.org file which doesn't require a login. You're good to go.

Synchronizing with Dropbox or Google Drive

If your new feature does require the Dropbox or Google Drive synchronization back-end, there's an extra step you need to perform.

Both Dropbox and Google Drive require a whitelist of domains that they can be synchronized from. The whitelist for local domains is exclusively short: http://localhost:3000.

Hence, to be able to login from your phone to your dev instance of organice, you'll need to set up port forwarding. If you have a shell on your phone and an ssh client, you can do that with the following command:

ssh -L 3000:localhost:3000 user-dev-machine

If you don't have a shell on your phone, you can use a dedicated SSH application (like Terminus).

5.4 Contributions

Please see our contributor guidelines and our code of conduct.

6 Deployment

Since organice is a front-end only application, it can easily be deployed to any server capable of serving a static application.

Please note: If you want the hosted application to connect to Dropbox or Google Drive, please read the section on Synchronization back-ends.

6.1 FTP

First create the production build locally: yarn run build Note: Creating a build will actually make your REACT_APP_* variables from the .env file available under process.env even though it'll be a front-end application.

And then upload to your web-server. Here's a script for your convenience:

HOST='your_ftp_server_host'
USER='ftp_user'
PASSWD='ftp_password'

lftp $HOST <<END_SCRIPT
user $USER $PASSWD
mirror -R build/
quit
END_SCRIPT
exit 0

6.2 Docker

organice is also available as a Docker image.

6.2.1 With docker-compose

If docker-compose is installed, the following command downloads and runs the latest image automatically.

docker-compose up -d

The webserver is listening on port 5000 and can be reached here: http://localhost:5000

If you want to build the image yourself, use the docker-compose-dev.yaml file:

docker-compose -f docker-compose-dev.yaml up

6.2.2 Without docker-compose

If docker-compose is not installed the command looks like this:

docker run -p 5000:5000 --name organice twohundredok/organice:latest

Again the webserver is listening on port 5000 and can be reached here: http://localhost:5000

6.3 Heroku

Assuming, you have an account and have installed the command line tools, deployment is as easy as:

heroku create
heroku config:set ON_HEROKU=1
git push heroku master

6.4 Synchronization back-ends

Note that logging in to Dropbox will only work if you're running the app on http://localhost:3000, because all redirect URIs must be specified ahead of time on the Dropbox developer console.

To configure your own application on Dropbox, please go here and then configure this app key in the .env file. Make sure to add your own URL as Redirect URI.

To configure your own application on Google Drive, please generate an API key as described on this page.

6.4.1 WebDAV

  1. General

    With WebDAV support, organice can potentially be used with a multitude of synchronization backends: Client/Server services ownCloud, Nextcloud and Seafile, but also self hosted dedicated WebDAV servers like Apache or Nginx.

  2. More information

    In the WebDAV FAQ, you'll find lots more information regarding WebDAV:

    • A screencast of how organice works when logging in to a WebDAV server
    • Documentation how on to setup your own WebDAV Server with Apache2 on Debian
    • Documentation how to configure Nextcloud behind haproxy to allow WebDAV
    • Documentation on Nextcloud sharing

6.5 Routing

Whilst organice is a true Single Page Application (SPA) and therefore has no back-end whatsoever, this does have an implication for deployment with regard to routing. For routes like example.com/foo to work, we need a little something extra. Within the context of a running SPA, /foo would be matched by the React Router and the proper page would be rendered by JavaScript. When initially requesting a route like that from the web server itself, the SPA is not running yet and the web server itself wouldn't find a file called /foo. It would return a 404. The whole topic is explained in depth in this SO answer: https://stackoverflow.com/a/36623117

For https://organice.200ok.ch we've opted to:

  • Use the modern HTML5 history API with BrowserRouter
  • Not configure a back-end for isomorphic routing, because it would complicate application and deployment unnecessarily (SEO is a non-issue for organice)
  • Use good old Apache Webserver for hosting the compiled static assets

Therefore configuring a catchall is as easy as setting up a .htaccess file in the root of the organice folder containing:

RewriteEngine On
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} -f [OR]
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} -d
RewriteRule ^ - [L]

RewriteRule ^ /index.html [L]

N.B.: If you're using WebDAV as a sync back-end, and the RewriteRule is allowed to apply to a WebDAV directory, it will break PUT requests to upload new files! Here's documentation on how to configure both features together correctly.

7 Capture templates

organice supports capture templates by implementing a flexible mechanism using URL parameters. These three of the following parameters are required and must be URL encoded:

  • captureTemplateName: the name of the capture template to use. This capture template must already exist in Settings > Capture templates.
  • captureFile: the path (for Dropbox) or id (for Google Drive) of the file in which to execute the capture template.
  • captureContent: the content you'd like to capture. This content will be placed at the cursor position if specified in the capture template (with %?), or at the end of the template if its not specified.

You can also specify additional custom variables for use in your templates. They should be in the format captureVariable_<your custom variable>, and should also be URL encoded. In your capture template they'd show up as %<your custom variable>.

organice allows you to specify where the captured content will be inserted, via a "header path" which is a list of headers to match. If the list is empty, the content will be inserted at the end of the file, or the beginning if the prepend option is selected.

7.1 Examples

7.1.1 Simple: Capture a string

Say, you want to capture thoughts/todos as they occur to you. You might want to have a capture template to just get these things out of your head.

This makes for a good "Inbox" capture template:

Capture Template

* TODO %?
%U

Example URL

https://organice.200ok.ch?captureTemplateName=Inbox&captureContent=Read+up+on+capture+templates&captureFile=/org/things.org

Result

* TODO Read up on capture templates
[2019-09-08 Sun 20:54]

7.1.2 With custom variable

If you want to add web pages to a reading queue (with a title, a capture date and a URL), this would be a good starting point:

Capture Template

* %?
%u

- URL: %mediaURL

Example URL

https://organice.200ok.ch?captureTemplateName=Media&captureContent=Play+Emacs+like+an+instrument&captureFile=/org/media.org&captureVariable_mediaURL=https://200ok.ch/posts/2018-04-27_Play_Emacs_like_an_Instrument.html

Result

* Play Emacs like an instrument
[2019-09-08 Sun]

- URL: https://200ok.ch/posts/2018-04-27_Play_Emacs_like_an_Instrument.html

8 Bookmarklets

Since organice is a web application, you can use the capture templates feature to create bookmarklets, of course! For example, if you want a bookmarklet to add the current page (title, capture date and URL) to your reading queue using this capture template, all you need is a little bit of JavaScript:

javascript:(function() {
  const {title} = document;
  const url = `https://organice.200ok.ch?captureTemplateName=Media&captureContent=${title}&captureFile=/org/media.org&captureVariable_mediaURL=${
  window.location.href
}`;
  window.open(url, "_blank");
})()

8.1 Bookmarklets Demo

8.1.1 iOS

This is what using a bookmarklet to capture a website looks like in iOS:

demo-bookmarklet-iOS.gif

9 Siri integration

The organice capture mechanism integrates very nicely with the Siri Shortcuts feature in iOS, allowing you to use Siri to execute capture templates.

You can use this sample Shortcut to get started with this right away in iOS 12 or newer. Open the link on your iOS device and click "Get Shortcut". Then open up the Shortcuts app and edit the template by following the directions in the comments. Then record a Siri trigger and you're good to go!

10 Comparison

10.1 Beorg

Before starting work on organice, @munen (the original maintainer) used Beorg and donated to it multiple times, because he was very happy to have a good option to access Org files on my phone with it.

The important differences to him were:

  • organice is FOSS which is very much in the spirit of Org whilst Beorg is proprietary
  • organice is web based, so there is no lock-in to a specific device or OS
  • Beorg currently has better offline support

10.2 org-web

organice has a shared history with org-web. In fact, it is a friendly fork. organice differs from org-web in that:

  • organice is a community driven project. See our
  • organice has the commitment of a Swiss company behind it to continually work on it.
    • This company is 200ok llc: https://200ok.ch/
    • The continuous effort yields a certain power over time. At the time of writing this, organice has ~3 times as many commits (1500 vs 600) and contributors (25 vs. 8). Of course, quality doesn't trump quantity. However, many of the new contributors brought significant features and improvements, not just tiny patches.
  • organice initially focused on becoming bug free - for example on parsing and exporting org files correctly.
  • organice continues to evolve independently with its own feature set. For example, it has WebDAV support.
  • organice is a project with equal focus on mobile as desktop browsers.
  • org-web tracks users with Google Analytics. organice does not.
  • organice has great documentation: https://organice.200ok.ch/documentation.html

10.2.1 What's new?

To see how organice differs from org-web, please consult the changelog which contains the user visible changes since forking.

10.2.2 Acknowledgment

We are extraordinarily grateful to DanielDe, the original creator!

We forked the project, because we have different visions on how to go forward. He envisions a mobile only solution, we think it's great to have organice be available to any browser to enable anyone on the go or any non-Emacs user easy access to Org files. Also, DanielDe thinks of org-web as his pet project whereas organice has the full power of 200ok llc behind it whilst building a strong self-sufficient community around it.

Thank you for all, DanielDe!🙏

11 Attributions

11.1 Logo

Illustration credit: Vecteezy.com

12 FAQ synchronization back-ends

12.1 Dropbox

12.1.1 Permissions ("Full Dropbox" vs. "App folder")

The reference organice host https://organice.200ok.ch/ has the permission type "Full Dropbox". This serves many users well - especially those who have Org files in various locations that they want to access.

If you're a user and have concerns to give an application full access to your Dropbox, here are your options:

  1. You might not need to change anything after reading this: organice is a front-end application, there is no back-end and no monitoring whatsoever. So, when you login to Dropbox, only your browser will have access to your Dropbox. So, from a security perspective, you're not giving too much access to a server - your data cannot be seen by anyone else but you.
  2. organice is a free and open source application. Therefore, you can review the synchronization code anytime. For Dropbox, this is pretty straight forward since the synchronization code is less than 200loc.
  3. If you still have concerns, you can take full control! Since organice is free and open source, you are free to host it yourself. You can also create your own integration with Dropbox and select the permissions as you wish. Here's more documentation on deploying organice.

12.2 WebDAV

12.2.1 Demo

Here's a demo of how organice works when logging in to a WebDAV server.

On the left, you see a branded version of OwnCloud, on the right you see organice. After logging in and making a minute change, you can see that the last edited timestamp in OwnCloud changes. Also, we're verifying the change directly in Emacs using Emacs and you can see the change has also been synchronized to my local machine.

demo-webdav.gif

12.2.2 WebDAV test server

For testing purposes, we use a Docker image with a proven and well documented server: Apache2 running on Debian. You can build the Docker image yourself - and customize the Apache configuration to your needs:

docker build -f doc/webdav/Dockerfile -t apache-webdav .

Then run the Apache2 WebDAV server with:

docker run -dit --name apache-webdav-app -p 8080:80 apache-webdav

On your host machine, you can now login with any WebDAV client using the URL http://localhost:8080/webdav. There is no authentication configuration, so any user account works (including omitted user accounts). It goes without saying that if you wanted to use this for production, please enable authentication. Within the test image, you'll find the sample.org file, so you can get started developing and testing right away.

For testing WebDAV outside of organice, and you're an Emacs user, you can open this link (C-c C-o). Then, you will get a TRAMP session with dired open and you'll see the sample file. You can interact with it like in any other dired buffer. Obviously, this link will not work when looking at the documentation in the browser, you'll have to open the file WIKI.org in Emacs.

If you prefer a command line client, you could use cadaver. Install and use it like this:

sudo apt -y install cadaver
cadaver http://localhost:8080/webdav/
  1. Bug reports

    If you have any trouble connecting to WebDAV using organice, it could be your setup (please consult CORS and Gotchas with WebDAV). In any case, if you want to open a bug report, please document your issue by referencing how it doesn't work using the official WebDAV test server.

12.2.3 CORS

Since organice is a front-end application, it will login with JavaScript from within the browser - in turn the Cross-Origin Resource Sharing (CORS) headers must be set appropriately. If they are not set, you will not be able to login to your service from a browser. Alternatively, if you're using a server like Apache or Nginx, you can simply get around CORS by hosting organice on the same domain as your service.

Please note, that when your back-end does not set the correct CORS headers, organice cannot show you a really semantic error message on that. The reason is that browsers hide this information from JavaScript. You will simply get a network error. However, you can easily debug it yourself by looking into the JavaScript console. No worries, you don't have to be a (JavaScript) developer to find out about that - here's a screencast showing you how to do it:

demo-webdav-failing-cors.gif

12.2.4 Gotchas with WebDAV

  1. preflight request doesn't pass access control check error

    If you are getting an error like

    Access to XMLHttpRequest at 'https://my.site/dav/' from origin
    'https://organice.200ok.ch' has been blocked by CORS policy: Response
    to preflight request doesn't pass access control check: It does not
    have HTTP ok status.
    

    then something is wrong with your webserver config. You can check whether a CORS preflight check is returning the right headers via:

    curl -v -X OPTIONS https://my.server/webdav/
    
    # For the official organice Apache2 WebDAV test server:
    # curl -v -X OPTIONS http://localhost:8080/webdav/
    

    The output should include lines like this:

    ...
    < HTTP/1.1 200 OK
    ...
    < Access-Control-Allow-Origin: *
    < Access-Control-Allow-Methods: GET,POST,OPTIONS,DELETE,PUT,PROPFIND
    < Access-Control-Allow-Headers: Origin,Accept,X-Requested-With,Content-Type,Access-Control-Request-Method,Access-Control-Request-Headers,Authorization,X-CSRF-Token,Depth
    < Access-Control-Allow-Credentials: true
    < Allow: OPTIONS,GET,HEAD,POST,DELETE,TRACE,PROPFIND,PROPPATCH,COPY,MOVE,LOCK,UNLOCK
    

    If your server doesn't give a 200 OK response, or if the Access-Control-Allow-* headers are missing, you may find these articles helpful:

  2. Using Apache RewriteEngine

    If your WebDAV directory happens to be not only on the same webserver, but also within a subdirectory of the directory containing a .htaccess file containing a RewriteRule that also applies to the WebDAV directory (for example like this), then you will need to create another .htaccess file in the top-level WebDAV directory containing this:

    RewriteEngine Off
    

    Otherwise any attempts to use WebDAV to upload new files via HTTP PUT requests will fall foul of the /index.html rewrite rule above, resulting in a 403 Forbidden response.

    Another way to avoid this more selectively is to precede that rule with:

    RewriteCond %{REQUEST_METHOD} !PUT
    
  3. Symlinks don't work
  4. Bind-mounts of individual files don't work

    In an Apache mod_dav context, unfortunately you can't use bind mounts of a single file instead of symlinks, because mod_dav attempts to write any changes to a file atomically, by first writing to a temporary file and then atomically renaming it to the target file, and Linux prevents renaming to bind mounts with a Device or resource busy error.

  5. HTTP PUT requests fail with 403 Forbidden

    As mentioned in the section routing, you should avoid having mod_rewrite rules apply to (PUT) requests in the WebDAV directories.

12.2.5 Configuring Nextcloud behind haproxy to allow WebDAV

If you're running Nextcloud behind haproxy it's entirely possible to use it with organice using WebDAV. …it's just a little bit convoluted.

The first part is the haproxy config. It should look a little bit like this:

frontend www
  acl host_nextcloud hdr(host) nextcloud.example.org
  acl path_nextcloud_public_webdav path_beg /public.php/webdav
  # Because we need to inspect the path in the backend section we set a variable
  # containing the path.
  http-request set-var(txn.path) path
  # Because the OPTIONS requests from organice doesn't include authentication we
  # need to fake it. We can do that by redirecting all requests that satisfy these conditions:
  #
  # + host is Nextcloud
  # + path is for public webdav
  # + HTTP method is OPTIONS
  use_backend always200ok if host_nextcloud path_nextcloud_public_webdav METH_OPTIONS

# haproxy doesn't really have a way of returning an arbitrary response, unless
# you want to drop down to Lua. There's no need for that, though, as this works
# perfectly fine. This backend doesn't have any servers attached, so it'll
# always result in a 503. We override the 503 by setting a custom errorfile,
# which incidentally looks just like an HTTP 200 response and contains all the
# headers we need to satisfy a CORS request.
backend always200ok
  mode http
  errorfile 503 /etc/haproxy/errors/200-ok.http

# The Nextcloud server backend is configured here. We inject CORS headers if URL
# starts with `/public.php/webdav`.
backend nextcloud
  mode http
  option httplog
  acl is_webdav var(txn.path) -m beg /public.php/webdav
  http-response add-header Access-Control-Allow-Origin "*" if is_webdav
  http-response add-header Access-Control-Allow-Methods "GET,POST,OPTIONS,DELETE,PUT,PROPFIND" if is_webdav
  http-response add-header Access-Control-Allow-Headers "Origin,Accept,X-Requested-With,Content-Type,Access-Control-Request-Method,Access-Control-Request-Headers,Authorization,X-CSRF-Token,Depth" if is_webdav
  http-response add-header Access-Control-Allow-Credentials "true" if is_webdav
  server backend01 127.0.0.1:8001

The errorfile needs to look something like the below. Note that the text below has carriage returns (13, o15 or 0x0d); these are required as per the HTTP RFC!

HTTP/1.1 200 OK
Cache-Control: no-cache
Connection: close
Content-Type: text/html
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,POST,OPTIONS,DELETE,PUT,PROPFIND
Access-Control-Allow-Headers: Origin,Accept,X-Requested-With,Content-Type,Access-Control-Request-Method,Access-Control-Request-Headers,Authorization,X-CSRF-Token,Depth
Access-Control-Allow-Credentials: true

<html><body><h1>200 Stuff is good!</h1>
Something something dark side.
</body></html>

12.2.6 Nextcloud sharing

In order to share a document using WebDAV you might be inclined to try to follow the official documentation, but it can be a tad confusing. Here's the executive summary for how to share things from Nextcloud using WebDAV:

  • share a link to a folder/file
  • remove everything but the token from the link; the token matches /[a-zA-Z0-9]+$/ (hit the button right of "Share link" if using the web interface)
  • use these details when logging in:
    URL
    https://nextcloud.example.org/public.php/webdav
    Username
    the token, e.g. ed65Fxw9Bz3MTn3
    Password
    if you've set a password for the shared folder, here's where you input it

13 Building this documentation

This comprehensive documentation is an aggregation of multiple files which all reside in the organice code repository (README.org, WIKI.org, CONTRIBUTING.org, and CODE_OF_CONDUCT.md).

Building this documentation is part of the CI/CD workflow. The actual compilation happens here and the result gets uploaded here.

14 Contribute to organice

First off, thank you for considering contributing to organice. It's people like you that make organice such a great tool!

14.1 Did you find a bug or do you want to implement a new feature?

What do we consider a bug? A bug is when an existing feature is broken.

A feature request is to ask for change in an existing feature or to ask for a completely new feature.

Hence, if your request is about a feature that Emacs Org mode has, but organice lacks, this is a feature request, not a bug.

  • Ensure the bug or feature was not already reported by searching on GitHub under Issues.
  • Ensure that the the bug you want to report is not known behavior by reading the readme and the wiki.
  • If you're unable to find an open issue addressing the problem, open a new one.
    • If you want to report a bug or request a feature, please use the "Bug report" or "Feature request" ticket and fill out the asked for metadata.
    • If your request is neither about a bug nor feature, please do open a blank issue.

14.2 How we work with issues

One of our quality goals is to keep the amount of issues manageable. This means that a single person has to be able to groom the backlog (review the open issues) in a reasonable amount of time.

These are the steps we take to ensure a high quality in the backlog:

  1. We only keep issues open on a longer term basis that fulfill one of the following criteria
    • Someone has committed to work on it or plausibly plans to do so in the future
    • It is a bug or regression
  2. If someone files a bug or feature request which is either not clear to the maintainers or is likely not a bug, but known and documented behavior, we ask a question or link to the documentation. We also add a 'question' label to the issue. If the issue creator does not respond to the question within 5 days, we close the issue. If she does choose to respond at some point, she can re-open the issue.

14.3 Contributing to the documentation

The documentation is generated from README.org and various other files. The section on building documentation explains how it is assembled.

14.4 Development collaboration

We have good quality assurance and an established workflow. This is it:

  1. Open a new GitHub pull request
  2. In the form of a User Story (As <persona>, [When I <state> ], I want <something>, so that <measurable achievement>
  3. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
  4. New Branch in Git
  5. Naming: (feature|fix|chore)/issue-id/short-description
  6. Develop / Test locally until tests pass
    • We use prettier-eslint to format code, which combines both prettier and eslint --fix for the best of both worlds. This repository includes .prettierrc.json and .eslintrc.yml with some configuration options that Prettier will use automatically.
    • Run yarn prettier-eslint --write to automatically format the whole codebase, or yarn prettier-eslint --list-different to see which files don't currently match the repository's style.
    • If you're using Emacs, you can autoformat your source files: https://github.com/munen/emacs.d/#auto-formatting
    • Please use eslint to ensure that your changes conform with our linting rules. You can run yarn eslint to check for rule violations, and also yarn nibble to tackle them one category at a time.
    • yarn lint will run both sets of linters.
  7. Create Pull Request on Github to master
    • Check that the tests also pass on CI
  8. Core Team: Merge to master, deploy and accept the Issue on Github

14.4.1 Definition of Done

An issue is done when:

  • Functionality has been implemented
  • Functionality has been verified
  • Surrounding main functionality has been regression tested
  • Code has been reviewed
    • Proper code style
    • Code has tests (acceptance tests for user visible changes, otherwise at least unit tests)
    • Follows clean code guidelines and architecture best practices
    • Code has been documented
  • Code has been merged
  • Tested on supported browsers

Clean code guidelines

  • Create small and highly cohesive modules
    • Avoid long modules and classes
    • Extract modules to separate responsibilities
  • Create small methods or functions
    • Avoid long methods or functions
    • Extract methods or functions to separate responsibilities
    • Do one thing

Thanks! 🙏 🙇

organice Team

200ok llc and all contributors

15 Code of Conduct

15.1 Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

15.2 Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

15.3 Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

15.4 Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

15.5 Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@200ok.ch. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

15.6 Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

Created: 2020-07-10 Fri 16:35

Validate