From 7baccd1884a8a1c02a66e88f9e20df64155b5f0d Mon Sep 17 00:00:00 2001 From: "Antonio J. Delgado" Date: Tue, 28 Nov 2023 19:52:21 +0200 Subject: [PATCH] update some readme --- README.md | 36 +++++++++++------------------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 977c58b..65c4c8a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,6 @@ # mastodon Work In Progress!!! -Welcome to your new module. A short overview of the generated parts can be found -in the [PDK documentation][1]. - -The README template below provides a starting point with details about what -information to include in your README. +This module install and manage Mastodon, Redis and PostgreSQL servers. ## Table of Contents @@ -19,35 +15,25 @@ information to include in your README. ## Description -Briefly tell users why they might want to use your module. Explain what your -module does and what kind of problems users can solve with it. - -This should be a fairly short description helps the user decide if your module -is what they want. +Mastodon https://joinmastodon.org/ is a decrentralized social network using the ActivityPub protocol to federate. +This module install and configure it with the required components (PostgreSQL and Redis). ## Setup ### What mastodon affects **OPTIONAL** -If it's obvious what your module touches, you can skip this section. For -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. +This module will install PostgreSQL and Redis server. ### Setup Requirements **OPTIONAL** -If your module requires anything extra before setting up (pluginsync enabled, -another module, etc.), mention it here. +You need to generate these secrets: +- 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 -for upgrading, you might want to include an additional "Upgrading" section here. +You will need a host name registered in DNS. ### Beginning with mastodon