Skip to content

Commit c5b3cb2

Browse files
Merge pull request #60 from prose-im/master
Finalize
2 parents 33eaee0 + b12d470 commit c5b3cb2

17 files changed

Lines changed: 157 additions & 5 deletions

config/common.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@
4747
},
4848

4949
"categories" : {
50+
"guides" : {
51+
"basics" : "images/categories/guides/basics.svg",
52+
"dashboard" : "images/categories/guides/dashboard.svg",
53+
"operating" : "images/categories/guides/operating.svg"
54+
},
55+
5056
"references" : {
5157
"pod-api" : "images/categories/references/pod-api.svg",
5258
"pod-config" : "images/categories/references/pod-config.svg"
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

src/data/guides/dashboard/server-config/index.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,77 @@ TITLE: Configuring your server
22
INDEX: 2
33
UPDATED: 2025-05-15
44

5-
TODO
5+
Once initialized, your Prose server can be configured with the following sections:
6+
7+
- [Team Members](#team-members)
8+
- [Server Features](#server-features)
9+
- [Customization](#customization)
10+
- [Security & Encryption](#security-amp-encryption)
11+
- [Network Setup](#network-setup)
12+
- [Backup & Reset](#backup-amp-reset)
13+
14+
---
15+
16+
## Team Members
17+
18+
The Team Members screen is where:
19+
20+
- You can manage existing team members (eg. remove them)
21+
- Add new team members (by sending an invitation email to them)
22+
23+
$[Team members screen](![Team members screen, with invited members](team-members-demo.png))
24+
25+
---
26+
27+
## Server Features
28+
29+
Server Features is the section where you can fine-tune the policy of your server regarding:
30+
31+
- Storage of user messages in the server-backed archive
32+
- The retention time of the message archive
33+
- Whether users can upload and share files
34+
- Whether to encrypt uploaded files or not
35+
- How much time user uploads should be kept on the server (and removed after the expiration time)
36+
37+
$[Server configuration screen](![Server configuration screen](server-config-demo.png))
38+
39+
---
40+
41+
## Customization
42+
43+
The workspace Customization area is described in the [Customizing your workspace guide](/guides/dashboard/workspace-customization/).
44+
45+
$[Customization screen](![Customization screen, with configured details](customize-workspace-demo.png))
46+
47+
---
48+
49+
## Security & Encryption
50+
51+
The Security & Encryption area lets you:
52+
53+
- Specify if TOTP/MFA is mandated on your server (for all team members)
54+
- Configure the minimum required SSL/TLS protocol version (higher is more secure, and less compatible)
55+
56+
$[Security & Encryption screen](![Security & Encryption screen](settings-security-demo.png))
57+
58+
---
59+
60+
## Network Setup
61+
62+
The Network Setup area allows you to:
63+
64+
- Configure the visibility of your server on the network (is it allowed to communicate with other Prose servers?)
65+
- Show DNS records and setup instructions to configure your domain name
66+
- Run diagnostics to check for network configuration mistakes
67+
68+
$[Network Setup screen](![Network Setup screen](settings-network-demo.png))
69+
$[Network Setup screen (on network check)](![Network Setup screen, with active network check](network-checks-demo.png))
70+
$[Network Setup screen (on DNS records)](![Network Setup screen, with DNS records](dns-records-demo.png))
71+
72+
---
73+
74+
## Backup & Reset
75+
76+
You can download a full back up of your Pod from there, which can be used to quickly restore your Pod to a given state (with all its configuration and user data).
77+
78+
If you wish to perform a factory reset of your Pod, it is also possible. Make sure to download a backup of your Pod before you erase it!
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)