diff options
author | Jason Phan <jason@ket.so> | 2020-11-02 12:37:35 -0600 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2020-11-17 09:56:08 -0500 |
commit | 556a8fee24624f113dc8cea1c6bd3df64860097f (patch) | |
tree | cf0865a0a4fe37c975e29ff54d5052aa251a571e /meta.sr.ht | |
parent | c0e15caa779f58173329701f1160824eac603044 (diff) | |
download | sr.ht-docs-556a8fee24624f113dc8cea1c6bd3df64860097f.tar.gz |
Update meta.sr.ht installation/config pages
Diffstat (limited to 'meta.sr.ht')
-rw-r--r-- | meta.sr.ht/configuration.md | 23 | ||||
-rw-r--r-- | meta.sr.ht/configuration_reference.md | 5 | ||||
-rw-r--r-- | meta.sr.ht/installation.md | 35 |
3 files changed, 41 insertions, 22 deletions
diff --git a/meta.sr.ht/configuration.md b/meta.sr.ht/configuration.md new file mode 100644 index 0000000..68f43fe --- /dev/null +++ b/meta.sr.ht/configuration.md @@ -0,0 +1,23 @@ +--- +title: meta.sr.ht Configuration +--- + +This document covers the configuration process for meta.sr.ht. + +# Cronjobs + +- `metasrht-daily`: It is recommend to run this job daily. + +# Billing + +To enable billing, consult the `meta.sr.ht::billing` configuration section. You +will need a working Stripe account for payment processing, and may need to +install the additional `meta.sr.ht-billing` package to obtain additional +dependencies. + +# Users + +To create users, use `metasrht-manageuser`. For example, to create an +administrator: + + metasrht-manageuser -t admin -e <email> <username> diff --git a/meta.sr.ht/configuration_reference.md b/meta.sr.ht/configuration_reference.md new file mode 100644 index 0000000..45b88d8 --- /dev/null +++ b/meta.sr.ht/configuration_reference.md @@ -0,0 +1,5 @@ +--- +title: meta.sr.ht Configuration Reference +--- + +This document covers the configuration options for the meta.sr.ht service. diff --git a/meta.sr.ht/installation.md b/meta.sr.ht/installation.md index c8df4f1..7281049 100644 --- a/meta.sr.ht/installation.md +++ b/meta.sr.ht/installation.md @@ -1,34 +1,25 @@ --- -title: meta.sr.ht installation +title: meta.sr.ht Installation --- -meta.sr.ht is the central authentication and account service for the sr.ht -network, and a working meta.sr.ht installation is a basic requirement of running -any other sr.ht software. +This document covers the installation steps for meta.sr.ht, the central +authentication and account service for sr.ht. + +<div class="alert alert-warning"> + <strong>Warning:</strong> A working meta.sr.ht installation is a basic + requirement of running any other sr.ht service. +</div> # Installation -meta.sr.ht is a standard sr.ht web service and can be installed through the -[standard procedure](/installation.md). +meta.sr.ht can be installed with the [standard package +installation process](/installation.md#installing-from-packages). ## Daemons -- `meta.sr.ht`: the web service -- `meta.sr.ht-webhooks`: webhook delivery service +- `meta.sr.ht` - The web service. +- `meta.sr.ht-webhooks` - Webhook delivery service. ## Cronjobs -- `metasrht-daily`: purges old audit log entries and runs billing; run daily. - -## Billing configuration - -To enable billing, consult the `meta.sr.ht::billing` config section. You will -need a working Stripe account for payment processing, and may need to install -the additional `meta.sr.ht-billing` package to obtain additional dependencies. - -# Post-installation tasks - -## Creating users & admins - -Use the `metasrht-manageuser` script. `metasrht-manageuser -t admin -e <email> -<username>` will create an administrator. +- `metasrht-daily`: Purges old audit log entries and runs billing. |