Settings

Settings from appsettings.json in root directory looks like:

{
  "App": { // Base application settings
    "DisplayName": "",  // Name of your software displayed in header of site. Default if empty: Documentor.
    "ShowSequenceNumbers": true, // Show sequence number in navigation. Default: true.
    "Download": { // Direct link to download latest version of your software.
      "Url": "", // Url to download latest version of your software. Default: empty.
      "Version": "" // Version tag of latest version of your software, for example v1.0.0. Default: empty.
    },
    "ExternalLinks": { // External urls to download your software from any package managers .
      ...
    }
  },
  "Authorization": { // Authorizations settings.
    "Emails": [] // List containing email addresses available to authorize. Required to configure.
  },
  "Authentication": { // List of OAuth 2.0 providers. Required to configure at least one provider.
    ...
  },
  "IO": { // Application directories settings.
    "Pages": { // Pages content directory settings.
      "Path": "Pages" // Path relative to the root directory. Will be created if it does not exist. Default: Pages.
    },
    "Cache": { // Cache directory settings.
      "Path": "Cache", // Path relative to the root directory. Will be created if it does not exist. Default: Cache.
      "Expire": 604800 // Cache expire time in seconds. Default: 604800 (7 days).
    }
  },
  "Logging": { // Logging settings
    "LogLevel": {
      "Default": "Error", // Min log level for exception by Application. Default: Error
      "Microsoft": "Error" // Min log level for exception by Microsoft.*. Default: Error
    }
  }
}

Required

  1. Configure at least one OAuth 2.0 provider (Supported: Google, GitHub, Facebook, Yandex, Vkontakte) in section Authentication.

    For example:

     "GitHub": {
     	"ClientId": "ac09asd850f98e5fc24",
     	"ClientSecret": "a2d78f2b09keaf79f4f32cec1def574e000l41e"
     }
    
  2. Add at least one email address to configure Authorization section. With that email address you should authorize by configured OAuth provider.

    For example:

     Authorization": {
     	"Emails": ["my@email.com"] 
     }
    

Without configured Authentication and Authorization sections you can't manage content by web interface, but you can still manage them by file system. See more details in Content management chapter.