Skip to content

braid-org/antimatter_wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Antimatter Wiki

A collaborative wiki based on the Antimatter Algorithm.

Installation

npm install -g antimatter_wiki

Quick Start

  1. Create a data directory for the wiki:
    mkdir my_wiki
    cd my_wiki
  2. Run the wiki server:
    antimatter_wiki
  3. Open your browser and navigate to:
    http://localhost:1001/any-page-name
    

Now click the "edit" button in the lower-right, and edit the page to create it!

Configuration

Command Line Options

antimatter_wiki [port] [cert_file] [key_file]
Parameter Description Default
port Port number to serve on 1001
cert_file SSL certificate file for HTTPS none
key_file SSL key file for HTTPS none

Examples

Run on a different port:

antimatter_wiki 8080

Run with HTTPS:

antimatter_wiki 443 /path/to/cert.pem /path/to/key.pem

Data Storage

The wiki automatically creates and uses a antimatter_wiki_db directory in your current working directory to store all wiki pages and data.

About

A collaborative wiki using the Antimatter Algorithm

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 2

  •  
  •