update some readme

This commit is contained in:
Antonio J. Delgado 2023-11-28 19:52:21 +02:00
parent 35cbf36bab
commit 7baccd1884

View file

@ -1,10 +1,6 @@
# mastodon Work In Progress!!! # mastodon Work In Progress!!!
Welcome to your new module. A short overview of the generated parts can be found This module install and manage Mastodon, Redis and PostgreSQL servers.
in the [PDK documentation][1].
The README template below provides a starting point with details about what
information to include in your README.
## Table of Contents ## Table of Contents
@ -19,35 +15,25 @@ information to include in your README.
## Description ## Description
Briefly tell users why they might want to use your module. Explain what your Mastodon https://joinmastodon.org/ is a decrentralized social network using the ActivityPub protocol to federate.
module does and what kind of problems users can solve with it. This module install and configure it with the required components (PostgreSQL and Redis).
This should be a fairly short description helps the user decide if your module
is what they want.
## Setup ## Setup
### What mastodon affects **OPTIONAL** ### What mastodon affects **OPTIONAL**
If it's obvious what your module touches, you can skip this section. For This module will install PostgreSQL and Redis server.
example, folks can probably figure out that your mysql_instance module affects
their MySQL instances.
If there's more that they should know about, though, this is the place to
mention:
* Files, packages, services, or operations that the module will alter, impact,
or execute.
* Dependencies that your module automatically installs.
* Warnings or other important notices.
### Setup Requirements **OPTIONAL** ### Setup Requirements **OPTIONAL**
If your module requires anything extra before setting up (pluginsync enabled, You need to generate these secrets:
another module, etc.), mention it here. - mastodon::db_password
- mastodon::secret_key_base
- mastodon::otp_secret
- mastodon::vapid_private_key
- mastodon::vapid_public_key
If your most recent release breaks compatibility or requires particular steps You will need a host name registered in DNS.
for upgrading, you might want to include an additional "Upgrading" section here.
### Beginning with mastodon ### Beginning with mastodon