- A wiki
- Minimalist
- Requires cmark
- Editing a page locks it
- Users can only have one locked page at a time
- Accounts can be added or removed easily and pages can be locked from future changes
- Files can be uploaded and linked inline
- Output is a static page
- Requires Redis
- ACE editor
- A wiki
- A reachable Redis Server
- wget http://download.redis.io/redis-stable.tar.gz
- tar xzf redis-stable.tar.gz
- cd redis-stable
- make
- sudo make install
- cd utils/
- sudo ./install_server.sh
- sudo /etc/init.d/redis_6379 start
- A usable cmark installed (Note: cmake and cmark are different programs)
- sudo apt-get install cmake
- git clone https://github.com/jgm/cmark.git
- cd cmark
- make
- sudo make install
- Download an OS+Architecture appropriate release
- Extract and run with the 'gen' flag to create a sample config file (in Linux you might run:
./edit -gen
) - Tweak the config.json file as needed
- Provide or generate a cert.pem and key.pem (see below)
- Run the edit binary (in Linux you might run:
./edit
)
- If you want to run on a privileged port, I recommend using CAP_NET_BIND_SERVICE instead of sudo
- Open a URL
- Login using a valid account. The default is 'admin'/'password' - you can not do anything (other than change the password) without changing this password (see below)
- Press Ctrl-e
- Enter CommonMark
- Press Ctrl-s
- Click on the Lock icon to let someone else edit the page, or wait for the lock to timeout
- Change your password by clicking on the menu button in the upper-right corner
- There is an admin page at /admin
- There is a Table-of-Contents at /toc
- URL Paths are only allowed to contain lowercase a-z or '/' or '_'
- Ctrl-e will toggle the edit panel
- Generate a new unencrypted rsa private key in PEM format:
openssl genrsa -out key.pem 1024
- Create a certificate signing request (CSR) using your rsa private key:
openssl req -new -key key.pem -out cert.csr
- Self-sign your CSR with your own private key:
openssl x509 -req -days 3650 -in cert.csr -signkey key.pem -out cert.pem
You can find the license in the LICENSE file.