# README

[![Build Status](https://jenkins.confdroid.com/job/confdroid_gitea/badge/icon?style=plastic)](https://jenkins.confdroid.com/job/confdroid_gitea/)


- [README](#readme)

## Synopsis

`Gitea` is a very nice lightweight git server and ideal for selfhosting repos i.e. for single developers without vendor lock. It can be installed standalone or as Docker / Kubernetes instance. 

`confdroid_gitea` automates the installation and configuration of gitea as standalone instance. It uses the provided downloadable binaries and sets up a full server instance based on that.

## WARNING

---Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production---

## Features

You must set `ga_host_fqdn` and specify the correct hostname, else nothing will be configured to avoid having accidently multiple hosts configured as gitea server. 

Installation
- install required binaries. 

Configuration

- install required system user
- manage directory structure 
- manage configuration files 
  - file system permissions
  - selinux context
- manage firewall settings (optional)
- configure & manage the service

### Dependencies

All listed dependencies must be included in the catalogue.

## Deployment

- native Puppet deployment

via site.pp or nodes.pp

```bash
node 'example.example.net' {
  include confdroid_apache
}
```

- through Foreman:

In order to apply parameters through Foreman, --__confdroid_apache::params__-- must be added to the host or host group in question.

See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).

## Parameters

The parameters are documented via puppet strings and [listed here](/docs/index.html). Simply open in web browser.

## SELINUX

All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.

## Support

- OS: Rocky 9
- Puppet 8

## Tests

- Puppet Lint
- Puppet Parser
- ERB Template Parser
- Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
- Sonar Quality Gate

## Contact Us

[contact Us](https://confdroid.com/contact/)
[Feedback Portal](https://feedback.confdroid.com/)

## Disclaimer

ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.