103 lines
3.4 KiB
Markdown
103 lines
3.4 KiB
Markdown
# mastodon Work In Progress!!!
|
|
|
|
This module install and manage Mastodon, Redis and PostgreSQL servers.
|
|
|
|
## Table of Contents
|
|
|
|
1. [Description](#description)
|
|
1. [Setup - The basics of getting started with mastodon](#setup)
|
|
* [What mastodon affects](#what-mastodon-affects)
|
|
* [Setup requirements](#setup-requirements)
|
|
* [Beginning with mastodon](#beginning-with-mastodon)
|
|
1. [Usage - Configuration options and additional functionality](#usage)
|
|
1. [Limitations - OS compatibility, etc.](#limitations)
|
|
1. [Development - Guide for contributing to the module](#development)
|
|
|
|
## Description
|
|
|
|
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**
|
|
|
|
This module will install PostgreSQL and Redis server.
|
|
|
|
### Setup Requirements **OPTIONAL**
|
|
|
|
You need to generate these secrets:
|
|
- mastodon::db_password
|
|
- mastodon::secret_key_base
|
|
- mastodon::otp_secret
|
|
- mastodon::vapid_private_key
|
|
- mastodon::vapid_public_key
|
|
|
|
You will need a host name registered in DNS.
|
|
|
|
### Beginning with mastodon
|
|
|
|
The very basic steps needed for a user to get the module up and running. This
|
|
can include setup steps, if necessary, or it can be an example of the most basic
|
|
use of the module.
|
|
|
|
## Usage
|
|
|
|
Include usage examples for common use cases in the **Usage** section. Show your
|
|
users how to use your module to solve problems, and be sure to include code
|
|
examples. Include three to five examples of the most important or common tasks a
|
|
user can accomplish with your module. Show users how to accomplish more complex
|
|
tasks that involve different types, classes, and functions working in tandem.
|
|
|
|
## Reference
|
|
|
|
This section is deprecated. Instead, add reference information to your code as
|
|
Puppet Strings comments, and then use Strings to generate a REFERENCE.md in your
|
|
module. For details on how to add code comments and generate documentation with
|
|
Strings, see the [Puppet Strings documentation][2] and [style guide][3].
|
|
|
|
If you aren't ready to use Strings yet, manually create a REFERENCE.md in the
|
|
root of your module directory and list out each of your module's classes,
|
|
defined types, facts, functions, Puppet tasks, task plans, and resource types
|
|
and providers, along with the parameters for each.
|
|
|
|
For each element (class, defined type, function, and so on), list:
|
|
|
|
* The data type, if applicable.
|
|
* A description of what the element does.
|
|
* Valid values, if the data type doesn't make it obvious.
|
|
* Default value, if any.
|
|
|
|
For example:
|
|
|
|
```
|
|
### `pet::cat`
|
|
|
|
#### Parameters
|
|
|
|
##### `meow`
|
|
|
|
Enables vocalization in your cat. Valid options: 'string'.
|
|
|
|
Default: 'medium-loud'.
|
|
```
|
|
|
|
## Limitations
|
|
|
|
In the Limitations section, list any incompatibilities, known issues, or other
|
|
warnings.
|
|
|
|
## Development
|
|
|
|
In the Development section, tell other users the ground rules for contributing
|
|
to your project and how they should submit their work.
|
|
|
|
## Release Notes/Contributors/Etc. **Optional**
|
|
|
|
If you aren't using changelog, put your release notes here (though you should
|
|
consider using changelog). You can also add any additional sections you feel are
|
|
necessary or important to include here. Please use the `##` header.
|
|
|
|
[1]: https://puppet.com/docs/pdk/latest/pdk_generating_modules.html
|
|
[2]: https://puppet.com/docs/puppet/latest/puppet_strings.html
|
|
[3]: https://puppet.com/docs/puppet/latest/puppet_strings_style.html
|