Configuration

You can configure and customize how all allmark serves your repositories by creating a custom repository configuration.
created by on 2015-08-03

Use the init action to save the default configuration to the current or given folder:

cd markdown-repository
allmark init

or

allmark init <directory path>

This will create a folder with the name .allmark in the current or the specified directory:

<your-markdown-repository>
└── .allmark
    ├── certs
    │   ├── cert.key
    │   └── cert.pem
    ├── config
    ├── templates
    │   ├── converter.gohtml
    │   ├── document.gohtml
    │   ├── error.gohtml
    │   ├── master.gohtml
    │   ├── opensearchdescription.gohtml
    │   ├── presentation.gohtml
    │   ├── repository.gohtml
    │   ├── robotstxt.gohtml
    │   ├── rssfeed.gohtml
    │   ├── rssfeedcontent.gohtml
    │   ├── search.gohtml
    │   ├── searchcontent.gohtml
    │   ├── sitemap.gohtml
    │   ├── sitemapcontent.gohtml
    │   ├── tagmap.gohtml
    │   ├── tagmapcontent.gohtml
    │   ├── xmlsitemap.gohtml
    │   └── xmlsitemapcontent.gohtml
    ├── theme
    │   ├── autoupdate.js
    │   ├── codehighlighting
    │   │   ├── highlight.css
    │   │   └── highlight.js
    │   ├── deck.css
    │   ├── deck.js
    │   ├── favicon.ico
    │   ├── jquery.js
    │   ├── jquery.lazyload.js
    │   ├── jquery.lazyload.srcset.js
    │   ├── jquery.lazyload.video.js
    │   ├── jquery.tmpl.js
    │   ├── latest.js
    │   ├── modernizr.js
    │   ├── presentation.js
    │   ├── print.css
    │   ├── screen.css
    │   ├── search.js
    │   ├── site.js
    │   ├── tree-last-node.png
    │   ├── tree-node.png
    │   ├── tree-vertical-line.png
    │   └── typeahead.js
    └── users.htpasswd

If you init a configuration in your home-directory, this configuration will be used as default for all your repositories as long as you don’t have one in your respective directory:

allmark init ~/

or

cd ~
allmark init

But configurations in your repositories will take precedence over your default configuration in your home-directory.

The configuration file has a JSON format and is located in .allmark/config:

{
	"Server": {
		"ThemeFolderName": "theme",
		"DomainName": "localhost",
		"HTTP": {
			"Enabled": true,
			"Bindings": [
				{
					"Network": "tcp4",
					"IP": "0.0.0.0",
					"Zone": "",
					"Port": 80
				},
				{
					"Network": "tcp6",
					"IP": "::",
					"Zone": "",
					"Port": 80
				}
			]
		},
		"HTTPS": {
			"Enabled": true,
			"Bindings": [
				{
					"Network": "tcp4",
					"IP": "0.0.0.0",
					"Zone": "",
					"Port": 443
				},
				{
					"Network": "tcp6",
					"IP": "::",
					"Zone": "",
					"Port": 443
				}
			],
			"CertFileName": "cert.pem",
			"KeyFileName": "cert.key",
			"Force": false
		},
		"Authentication": {
			"Enabled": false,
			"UserStoreFileName": "users.htpasswd"
		}
	},
	"Web": {
		"DefaultLanguage": "en",
		"DefaultAuthor": "",
		"Publisher": {
			"Name": "",
			"Email": "",
			"URL": "",
			"GooglePlusHandle": "",
			"TwitterHandle": "",
			"FacebookHandle": ""
		},
		"Authors": {
			"Unknown": {
				"Name": "",
				"Email": "",
				"URL": "",
				"GooglePlusHandle": "",
				"TwitterHandle": "",
				"FacebookHandle": ""
			}
		}
	},
	"Conversion": {
		"RTF": {
			"Enabled": true
		},
		"Thumbnails": {
			"Enabled": false,
			"IndexFileName": "thumbnail.index",
			"FolderName": "thumbnails"
		}
	},
	"LogLevel": "Info",
	"Indexing": {
		"IntervalInSeconds": 60
	},
	"Analytics": {
		"Enabled": false,
		"GoogleAnalytics": {
			"Enabled": false,
			"TrackingID": ""
		}
	}
}
Shortlink:
Tags:
Fork allmark on GitHub