xoxys.gitea/README.md

470 lines
7.3 KiB
Markdown
Raw Normal View History

2019-10-17 08:35:35 +02:00
# xoxys.gitea
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.gitea/status.svg)](https://drone.rknet.org/ansible/xoxys.gitea)
2019-11-06 21:10:08 +01:00
Setup a Gitea git server
2019-10-17 08:35:35 +02:00
## Table of content
* [Default Variables](#default-variables)
2019-11-22 13:44:38 +01:00
* [gitea_access_token_expiration_time](#gitea_access_token_expiration_time)
* [gitea_attachment_max_files](#gitea_attachment_max_files)
* [gitea_attachment_max_filesize](#gitea_attachment_max_filesize)
2019-10-17 08:35:35 +02:00
* [gitea_base_dir](#gitea_base_dir)
* [gitea_bin_dir](#gitea_bin_dir)
* [gitea_bind_ip](#gitea_bind_ip)
* [gitea_bind_port](#gitea_bind_port)
2019-11-22 13:44:38 +01:00
* [gitea_config_dir](#gitea_config_dir)
* [gitea_data_dir](#gitea_data_dir)
2019-10-27 17:12:52 +01:00
* [gitea_db_name](#gitea_db_name)
* [gitea_db_password](#gitea_db_password)
2019-11-22 13:44:38 +01:00
* [gitea_db_port](#gitea_db_port)
* [gitea_db_server](#gitea_db_server)
2019-10-27 17:12:52 +01:00
* [gitea_db_ssl_mode](#gitea_db_ssl_mode)
2019-11-22 13:44:38 +01:00
* [gitea_db_type](#gitea_db_type)
* [gitea_db_user](#gitea_db_user)
* [gitea_disable_registration](#gitea_disable_registration)
* [gitea_extra_groups](#gitea_extra_groups)
2019-10-17 08:35:35 +02:00
* [gitea_file_log_level](#gitea_file_log_level)
2019-11-22 13:44:38 +01:00
* [gitea_global_log_dir](#gitea_global_log_dir)
* [gitea_global_log_level](#gitea_global_log_level)
* [gitea_group](#gitea_group)
* [gitea_install_lock](#gitea_install_lock)
* [gitea_invalidate_refresh_tokens](#gitea_invalidate_refresh_tokens)
* [gitea_jwt_secret](#gitea_jwt_secret)
* [gitea_landing_page](#gitea_landing_page)
* [gitea_listen_address](#gitea_listen_address)
2019-10-17 08:35:35 +02:00
* [gitea_mail_service_enabled](#gitea_mail_service_enabled)
* [gitea_mail_service_from](#gitea_mail_service_from)
* [gitea_no_reply_address](#gitea_no_reply_address)
* [gitea_oauth_provider_enabled](#gitea_oauth_provider_enabled)
2019-11-22 13:44:38 +01:00
* [gitea_packages](#gitea_packages)
2019-10-17 08:35:35 +02:00
* [gitea_refresh_token_expiration_time](#gitea_refresh_token_expiration_time)
2019-11-22 13:44:38 +01:00
* [gitea_repository_upload_max_files](#gitea_repository_upload_max_files)
* [gitea_repository_upload_max_filesize](#gitea_repository_upload_max_filesize)
* [gitea_run_mode](#gitea_run_mode)
* [gitea_secret](#gitea_secret)
* [gitea_selinux_fcontext](#gitea_selinux_fcontext)
* [gitea_selinux_restorecon](#gitea_selinux_restorecon)
2019-10-17 08:35:35 +02:00
* [gitea_tls_cert_path](#gitea_tls_cert_path)
* [gitea_tls_cert_source](#gitea_tls_cert_source)
2019-11-22 13:44:38 +01:00
* [gitea_tls_enabled](#gitea_tls_enabled)
* [gitea_tls_key_path](#gitea_tls_key_path)
2019-10-17 08:35:35 +02:00
* [gitea_tls_key_source](#gitea_tls_key_source)
2019-11-22 13:44:38 +01:00
* [gitea_token](#gitea_token)
* [gitea_user](#gitea_user)
* [gitea_user_home](#gitea_user_home)
* [gitea_version](#gitea_version)
2019-10-17 08:35:35 +02:00
* [Dependencies](#dependencies)
* [License](#license)
* [Author](#author)
---
## Default Variables
2019-11-22 13:44:38 +01:00
### gitea_access_token_expiration_time
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_access_token_expiration_time: 3600
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_attachment_max_files
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_attachment_max_files: 5
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_attachment_max_filesize
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_attachment_max_filesize: 3
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_base_dir
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_base_dir: /opt/gitea
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_bin_dir
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_bin_dir: '{{ gitea_base_dir }}/bin'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_bind_ip
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_bind_ip: 127.0.0.1
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_bind_port
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_bind_port: 61000
2019-10-17 08:35:35 +02:00
```
### gitea_config_dir
#### Default value
```YAML
gitea_config_dir: '{{ gitea_base_dir }}/custom/conf'
```
### gitea_data_dir
#### Default value
```YAML
gitea_data_dir: '{{ gitea_base_dir }}/data'
```
2019-11-22 13:44:38 +01:00
### gitea_db_name
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_db_name: gitea
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_db_password
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_db_password: secure
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_db_port
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_db_port: 5432
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_db_server
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_db_server: localhost
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_db_ssl_mode
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_db_ssl_mode: disable
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_db_type
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_db_type: pgsql
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_db_user
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_db_user: pggitea
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_disable_registration
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_disable_registration: 'true'
2018-12-08 22:21:48 +01:00
```
2019-11-22 13:44:38 +01:00
### gitea_extra_groups
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_extra_groups: []
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_file_log_level
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_file_log_level: '{{ gitea_global_log_level }}'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_global_log_dir
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_global_log_dir: '{{ gitea_base_dir }}/log'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_global_log_level
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_global_log_level: Info
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_group
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_group: '{{ gitea_user }}'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_install_lock
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_install_lock: 'true'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_invalidate_refresh_tokens
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_invalidate_refresh_tokens: 'false'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_jwt_secret
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_jwt_secret: Bk0yK7Y9g_p56v86KaHqjSbxvNvu3SbKoOdOt2ZcXvU
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_landing_page
2018-12-08 22:21:48 +01:00
2019-10-17 08:35:35 +02:00
#### Default value
2018-12-08 22:21:48 +01:00
2019-10-17 08:35:35 +02:00
```YAML
2019-11-22 13:44:38 +01:00
gitea_landing_page: explore
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_listen_address
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_listen_address: http://gitea.example.com
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_mail_service_enabled
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_mail_service_enabled: false
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_mail_service_from
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_mail_service_from: '"System" <systemmail@example.com>'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_no_reply_address
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_no_reply_address: noreply.example.org
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_oauth_provider_enabled
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_oauth_provider_enabled: false
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_packages
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_packages:
- git
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_refresh_token_expiration_time
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_refresh_token_expiration_time: 730
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_repository_upload_max_files
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_repository_upload_max_files: 5
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_repository_upload_max_filesize
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_repository_upload_max_filesize: 3
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_run_mode
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_run_mode: prod
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_secret
Should be replaced by your own secret.
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_secret: 1234567ABCDEFG
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_selinux_fcontext
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_selinux_fcontext:
- target: '{{ gitea_global_log_dir }}(/.*)?'
setype: var_log_t
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_selinux_restorecon
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_selinux_restorecon:
- -ir {{ gitea_global_log_dir }}
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_tls_cert_path
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_tls_cert_path: '{{ gitea_base_dir }}/tls/certs/mycert.pem'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_tls_cert_source
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_tls_cert_source: mycert.pem
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_tls_enabled
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_tls_enabled: false
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_tls_key_path
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_tls_key_path: '{{ gitea_base_dir }}/tls/private/mykey.pem'
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_tls_key_source
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_tls_key_source: mykey.pem
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_token
Should be replaced by your own secret.
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_token: akslkaldasasifiuvsiasfa7s7f8as7f8asd
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_user
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_user: gitea_adm
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_user_home
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_user_home: /home/{{ gitea_user }}
2019-10-17 08:35:35 +02:00
```
2019-11-22 13:44:38 +01:00
### gitea_version
2019-10-17 08:35:35 +02:00
#### Default value
```YAML
2019-11-22 13:44:38 +01:00
gitea_version: 1.10.0
2019-10-17 08:35:35 +02:00
```
2018-12-08 22:21:48 +01:00
## Dependencies
2019-10-17 08:35:35 +02:00
None.
## License
MIT
## Author
2019-11-07 09:35:16 +01:00
[xoxys](https://gitea.rknet.org/xoxys)