Skip to content

rollyourown-xyz/ryo-project-template

Repository files navigation

rollyourown Project Template

This is the template repository structure for a rollyourown project.


The general architecture of a rollyourown project is documented here

The structure of a rollyourown project (which this template provides) is documented here

Contributing to this Template

Issues for this project template can be submitted on Codeberg (preferred) or GitHub:

  • Issues on Codeberg: here
  • Issues on GitHub: here

How to Use this Template

Clone this repository as a starting point for a new project and make the following changes:

This template README can be used for the new project by deleting this part, changing the title and introductory text above, and completing the sections below.


This is a rollyourown project to deploy <PROJECT_PURPOSE> using Ansible, Packer and Terraform.

Project Summary

This project uses Ansible, Packer and Terraform to deploy...

A short summary of the purpose of the project / module.

How to Use

A detailed description of how to use a rollyourown project to deploy and maintain an open source solution can be found on the rollyourown website.

In summary, to deploy a project:

  1. Acquire a domain to use for your project, or re-use a domain you already own

  2. Prepare a control node with the basic software to run the rollyourown automation scripts, or use an existing control node you have previously set up

  3. Prepare a host server for deploying the project to, or use an existing host server you have previously set up

  4. Enter the working directory (e.g. ~/ryo-projects) on the control node and clone the project repository from Codeberg or GitHub

     cd ~/ryo-projects
     git clone https://codeberg.org/rollyourown-xyz/<PROJECT_NAME>.git
    

    or

     cd ~/ryo-projects
     git clone https://github.com/rollyourown-xyz/<PROJECT_NAME>.git
    
  5. Copy the project's configuration file and add settings

     cd ~/ryo-projects/<PROJECT_NAME>
     cp configuration/configuration_TEMPLATE.yml configuration/configuration_<HOST_NAME>.yml
     nano configuration/configuration_<HOST_NAME>.yml
    
  6. Run the deployment script from the project directory

     cd ~/ryo-projects/<PROJECT_NAME>
     ./deploy.sh -n <HOST_NAME> -v <VERSION>
    

How to Collaborate

We would be delighted if you would like to contribute to rollyourown and there are a number of ways you can collaborate on this project:

You may also like to contribute to the wider rollyourown project by, for example:

Issues for this project can be submitted on Codeberg (preferred) or GitHub:

  • Issues on Codeberg: here
  • Issues on GitHub: here

Security Vulnerabilities

If you have found a security vulnerability in any rollyourown service or any of the rollyourown projects, modules or other repositories, please read our security disclosure policy and report this via our security vulnerability report form.

Repository Links

For public contributions, we maintain mirror repositories of this project on Codeberg and GitHub:

Our preferred collaboration space is Codeberg:

Get it on Codeberg

The primary repository for this project is hosted on our own Git repository server at:

Repositories on our own Git server are accessible only to members of our organisation.

Copyright, Licences and Trademarks

For information on copyright, licences and trademarks, see https://rollyourown.xyz/about/copyright_licenses_trademarks/.