Browse Source

Fix Markdown formatting

Zero King 6 years ago
parent
commit
2a22979661

+ 1 - 1
contrib/doc/cjdns-online.md

@@ -17,7 +17,7 @@ to wait until this IP is available before starting network services.
 This will increase your boot time somewhat, but is needed to launch
 thttpd at boot, for example.
 
-##OPTIONS
+## OPTIONS
 
   * `-t`, `--timeout` <timeout_value>:	
     time to wait in seconds, default 30

+ 3 - 3
contrib/doc/cjdnslog.md

@@ -10,7 +10,7 @@ cjdnslog(1) -- display cjdroute log messages
 Cjdroute has numerous log points.  Cjdnslog enables and taps selected log
 points and sends the resulting log messages to stdout.
 
-##OPTIONS
+## OPTIONS
 
 With no options, cjdnslog logs everything.
 
@@ -28,13 +28,13 @@ With no options, cjdnslog logs everything.
     Restrict output to message generated on source line lineno.  Normally
     used in conjunction with `-f`.
 
-##USAGE
+## USAGE
 
 Running cjdnslog requires admin privilege.  The cjdnsadmin lib will 
 try to read `/etc/cjdroute.conf` for the admin password.  This will 
 normally succeed only for root.  Otherwise, it tries `~/.cjdnsadmin`
 
-##FILES
+## FILES
 
 `~/.cjdnsadmin`
 

+ 2 - 2
contrib/doc/cjdroute.md

@@ -15,7 +15,7 @@ scalability issues that plague existing networks.
 cjdroute runs in the background and either decrypts packets addressed to
 this node, or sends them on to the next node in the route.
 
-##OPTIONS
+## OPTIONS
 
   * `--help`:
     Print usage summary.
@@ -36,7 +36,7 @@ this node, or sends them on to the next node in the route.
   * `--nobg`                
     Never fork to the background no matter the config.
 
-##USAGE
+## USAGE
 
 To get the router up and running:
 

+ 1 - 1
contrib/doc/makekeys.md

@@ -13,7 +13,7 @@ corresponding IP6 address and public key.  Sample:
     9b5520e11b4e1aac4e54cf8382ca219b6942f75519dbe7cc71fc6c4bb636a2db fca1:43dc:9e20:68dc:df3f:6bf1:fbf9:37ab x70u0x6sfh0yuushlq7wvcdxj8rgb8lvss9t6f42zp60ftq71cm0.k
     579db68cfdeaeda1ff7f365c73e620bedb0f68cb443a0cd7ef6bae16d0e1e12e fc68:b272:3aa3:cb4a:a686:dab0:7df5:2fb5 fmurp2qrb0yqmcjmbjtuhuxuf6v3rgmdn9hgsfh47k20h68y2lz0.k
 
-##USAGE
+## USAGE
 
 Example use:
 

+ 1 - 1
contrib/doc/peerStats.md

@@ -16,7 +16,7 @@ out to peers is configured in "connectTo" in either the IPv4 or IPv6 section.
 No admin privilege is needed to run peerStats, but it looks in `~/.cjdnsadmin`
 for the IP and admin port of cjdroute.
 
-##FILES
+## FILES
 
 `~/.cjdnsadmin`
 

+ 3 - 3
contrib/doc/sessionStats.md

@@ -20,18 +20,18 @@ so that past sessions (before the compromise) cannot be read.  The lifetime
 of a session is somewhat random.  Cjdroute caches recently active sessions,
 and destroys sessions that have not been used for a while.
 
-##USAGE
+## USAGE
 
 Running sessionStats requires admin privilege.  The cjdnsadmin lib will 
 try to read `/etc/cjdroute.conf` for the admin password.  This will 
 normally succeed only for root.  Otherwise, it tries `~/.cjdnsadmin`
 
-##FILES
+## FILES
 
 `~/.cjdnsadmin`
 `/etc/cjdroute.conf`
 
-##BUGS
+## BUGS
 If you get a TypeError, you probably have the wrong admin password.
 
 ## SEE ALSO

+ 1 - 1
contrib/doc/sybilsim.md

@@ -13,7 +13,7 @@ as cjdroute.  This is useful for testing and optimizing cjdroute.
 Every node must have a valid cjdns private key. The makekeys(1) utility can be
 useful for scripts that generate the config.  
 
-##USAGE
+## USAGE
 
 Example config:
 

+ 3 - 3
contrib/doc/traceroute.md

@@ -17,14 +17,14 @@ Cjdns-traceroute requires admin privilege.  The cjdnsadmin lib will
 try to read `/etc/cjdroute.conf` for the admin password.  This will 
 normally succeed only for root.  Otherwise, it tries `~/.cjdnsadmin`
 
-##USAGE
+## USAGE
 
-##FILES
+## FILES
 
 `~/.cjdnsadmin`
 `/etc/cjdroute.conf`
 
-##BUGS
+## BUGS
 Cjdns-traceroute throws an ugly exception if you forget
 to pass an IP or have the wrong admin password.
 

+ 1 - 1
doc/proxying.md

@@ -1,7 +1,7 @@
 Proxying
 ===========================
 
-#Keep in mind that we'd rather you put cjdns on all your machines!
+**Keep in mind that we'd rather you put cjdns on all your machines!**
 
 Sometimes it's just not possible to get cjdns working on a machine.
 

+ 4 - 4
doc/security_specification.md

@@ -1,8 +1,8 @@
-#Security Specification
+# Security Specification
 
 This document is here to help define security flaws in a way that can be agreed upon.
 
-##Definitions
+## Definitions
 
 * Reveal: To reveal a piece of content is to send over the wire that content or something from which
 that content can be mathematically derived (not withstanding theoretical attacks
@@ -15,14 +15,14 @@ address.
 * Permanent Private Key: The key which is in the configuration file which defines the node's
 identity.
 
-##Limitation of Scope
+## Limitation of Scope
 
 This document applies to the current version (latest master branch) of cjdns compiled and running
 on a Linux system using a version of GCC with no known security issues and running on an
 x86 or amd64 processor. Older versions and git branches may be non-compliant with this
 specification.
 
-##Integrity and Confidentiality
+## Integrity and Confidentiality
 
 1. It must not be possible to reveal the permanent private key or any temporary session private keys
 to anyone.

+ 10 - 10
doc/shorewall_and_vpn_gateway_howto.md

@@ -3,22 +3,22 @@ Tutorial for setting up an IP tunnel gateway from cjdns to clearnet, using a VPN
 
 * From: https://wiki.projectmeshnet.org/Gateway_server_howto
 
-##General
+## General
 * Close any open ports also on IPv6, e.g.:
  `ip6tables -A INPUT -i tun0 -p tcp --destination-port 22 -j REJECT`
 
-##VPN
+## VPN
 Connect to a VPN provider (I used mullvad.net). Make sure you can pay with bitcoins. Recommended connection: openvpn.
 
-##Firewall (shorewall)
-###Interfaces 
+## Firewall (shorewall)
+### Interfaces
 ```
  #ZONE INTERFACE BROADCAST OPTIONS
  net eth0 detect routefilter,dhcp,tcpflags,logmartians,nosmurfs
  cjdns tun0 detect routefilter,dhcp,tcpflags,logmartians,nosmurfs
  vpn tun1 detect routefilter,dhcp,tcpflags,logmartians,nosmurfs
 ```
-###Zones
+### Zones
 ```
  #ZONE   TYPE    OPTIONS                 IN                      OUT
  #                                       OPTIONS                 OPTIONS
@@ -27,7 +27,7 @@ Connect to a VPN provider (I used mullvad.net). Make sure you can pay with bitco
  cjdns   ipv4
  vpn     ipv4
 ```
-###Policy
+### Policy
 ```
  #SOURCE         DEST            POLICY          LOG LEVEL       LIMIT:BURST
  $FW             net             ACCEPT
@@ -42,7 +42,7 @@ Connect to a VPN provider (I used mullvad.net). Make sure you can pay with bitco
  # The FOLLOWING POLICY MUST BE LAST
  all             all             REJECT          info
 ```
-###Rules
+### Rules
 ```
  #ACTION         SOURCE                  DEST            PROTO   DEST
  #                                                       PORT
@@ -57,7 +57,7 @@ Connect to a VPN provider (I used mullvad.net). Make sure you can pay with bitco
  ACCEPT          $FW                     cjdns           icmp
  ACCEPT          cjdns                   $FW             icmp
 ```
-##Networking
+## Networking
 Give an IPV4 address to the server side of the cjdns tunnel:
 
  `ip addr add 10.42.0.3/32 dev tun0`
@@ -90,7 +90,7 @@ Remove original gateway:
 Use DNS server from VPN provider to avoid leaks:
  `cp /etc/resolv.conf.vpn /etc/resolv.conf`
 
-##Add user
+## Add user
 
 
 For convenience, I check the last 20 characters of the public key (not including .k) e.g.:
@@ -110,7 +110,7 @@ And under `ipTunnel` `allowedConnections`:
    "ip4Address": "10.42.something.else",
  },
 ```
-##Quota
+## Quota
 
 Add a user
 ```