Verified Commit 2e18da34 authored by Aral Balkan's avatar Aral Balkan
Browse files

Add information about configuration files used in Indie Site

parent bbf2ab44
---
title: "Configuration"
date: 2018-04-07T14:26:00+01:00
draft: false
weight: 15
---
Configuration data is stored in various JSON files in the data directory (_~/.indie_).
## server-secret.json
**This file contains a secret.**
* Generated on first run of the app.
* Never replaced/updated.
* Used when signing JSON Web Tokens (JWTs)
**Secret scope:** The secret must be secret to clients connecting to the server. It is known to the web host hosting the Indie Site and to anyone who access to the server.
```json
{
"serverSecret": "<server secret">
}
```
## installer-secret.json (Optional)
**This file contains a secret.**
This file is generated by the [Magic Website Factory](/hallo.gent/magic-website-factory) when an Indie Site instance is deployed by an Indie Site Installer (like [Hallo.gent](/hallo.gent)).
_If this file exists,_ the secret sign-up code that it contains is used to authenticate calls when an Indie Site is not yet configured to control access to the configuration functionality. For more information, see [Indie Site Deployment](/hallo.gent/indie-site-deployment).
```json
{
"secretSignUpCode": "<secret sign-up code>"
}
```
## owner-keys.json
<em>This file does <strong>not</strong> contain any secrets.</em>
Contains the following _non-secret_ key information:
* Derived private key salt
* Encrypted private signing key
* Encrypted private signing key nonce
* Public signing key
This information is:
* Generated during initial registration.
* Currently does not support being pathed/updated.
* Used for public-key authentication.
* To be used for end-to-end-encrypted private messages.
```json
{
"derivedKeySalt": "…",
"encryptedPrivateSigningKeyNonce": "…",
"encryptedPrivateSigningKey": "…",
"publicSigningKey": "…"
}
```
## owner-settings.json
<em>This file does <strong>not</strong> contain any secrets.</em>
Contains the owner’s site-related settings like name, bio, profile image, background image, theme colour, etc.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment