diaspora-formula
A saltstack formula to install and configure the distributed social network, diaspora*.
Table of Contents
General notes
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA
file and/or git tag
,
which contains the currently released version. This formula is versioned according to Semantic Versioning.
See Formula Versioning Section for more details.
If you need (non-default) configuration, please pay attention to the pillar.example
file and/or Special notes section.
Contributing to this repo
Commit messages
Commit message formatting is significant!!
Please see How to contribute for more details.
pre-commit
pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.
First install the pre-commit
package manager using the appropriate method, then run bin/install-hooks
and
now pre-commit
will run automatically on each git commit
.
$ bin/install-hooks pre-commit installed at .git/hooks/pre-commit pre-commit installed at .git/hooks/commit-msg
Special notes
This formula only manages diaspora. You are responsible for installing/configuring PostgreSQL or MariaDB as appropriate.
Available states
diaspora
Meta-state (This is a state that includes other states).
This installs diaspora, manages the diaspora configuration file and then starts the associated diaspora service.
diaspora.install
This state will install diaspora from GitHub and has a dependency on diaspora.config
via include list.
diaspora.config
This state will configure diaspora.
diaspora.service
This state will create and start the diaspora services and has a dependency on diaspora.install
via include list.
Testing
Linux testing is done with kitchen-salt
.
Requirements
- Ruby
- Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
Where [platform]
is the platform name defined in kitchen.yml
,
e.g. debian-9-2019-2-py3
.
bin/kitchen converge
Creates the docker instance and runs the diaspora
main state, ready for testing.
bin/kitchen verify
Runs the inspec
tests on the actual instance.
bin/kitchen destroy
Removes the docker instance.
bin/kitchen test
Runs all of the stages above in one go: i.e. destroy
+ converge
+ verify
+ destroy
.
bin/kitchen login
Gives you SSH access to the instance for manual testing.