matthew/helm-chart
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Format README (#408)

Browse Source 
Some small formatting changes which are auto-applied by the markdown code styler in vscode (which I am using a lot).

These are also present in #407.
Merging this before/in general would help be a bit when tinkering with the README.
Mainly indentation related, plus some single quotes -> double quotes changes.

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Reviewed-on: https://gitea.com/gitea/helm-chart/pulls/408
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.io>
Co-authored-by: pat-s <pat-s@noreply.gitea.io>
Co-committed-by: pat-s <pat-s@noreply.gitea.io>
This commit is contained in:
pat-s 2023-03-08 03:50:40 +08:00 committed by techknowlogick
parent 18100cca11
commit c46bf7c60f
3 changed files with 55 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.editorconfig Normal file
View File

@ -0,0 +1,12 @@
# EditorConfig is awesome: https://EditorConfig.org
# top-most EditorConfig file
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = false

1
CONTRIBUTING.md
View File

@ -14,6 +14,7 @@ When using Visual Studio Code as IDE, following plugins might be useful:
- [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) - [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
- [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) - [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
- [Helm Intellisense](https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense) - [Helm Intellisense](https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense)
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## Documentation Requirements ## Documentation Requirements

84
README.md
View File

@ -125,7 +125,7 @@ ENABLED = false
### Additional _app.ini_ settings ### Additional _app.ini_ settings
> **The [generic](https://docs.gitea.io/en-us/config-cheat-sheet/#overall-default) > **The [generic](https://docs.gitea.io/en-us/config-cheat-sheet/#overall-default)
section cannot be defined that way.** > section cannot be defined that way.**
Some settings inside _app.ini_ (like passwords or whole authentication configurations) Some settings inside _app.ini_ (like passwords or whole authentication configurations)
must be considered sensitive and therefore should not be passed via plain text must be considered sensitive and therefore should not be passed via plain text
@ -347,9 +347,9 @@ by default.
If you want to manage your own PVC you can simply pass the PVC name to the chart. If you want to manage your own PVC you can simply pass the PVC name to the chart.
```yaml ```yaml
persistence: persistence:
enabled: true enabled: true
existingClaim: MyAwesomeGiteaClaim existingClaim: MyAwesomeGiteaClaim
``` ```
In case that peristence has been disabled it will simply use an empty dir volume. In case that peristence has been disabled it will simply use an empty dir volume.
@ -358,20 +358,20 @@ PostgreSQL handles the persistence in the exact same way.
You can interact with the postgres settings as displayed in the following example: You can interact with the postgres settings as displayed in the following example:
```yaml ```yaml
postgresql: postgresql:
persistence: persistence:
enabled: true enabled: true
existingClaim: MyAwesomeGiteaPostgresClaim existingClaim: MyAwesomeGiteaPostgresClaim
``` ```
MySQL also handles persistence the same, even though it is not deployed as a statefulset. MySQL also handles persistence the same, even though it is not deployed as a statefulset.
You can interact with the postgres settings as displayed in the following example: You can interact with the postgres settings as displayed in the following example:
```yaml ```yaml
mysql: mysql:
persistence: persistence:
enabled: true enabled: true
existingClaim: MyAwesomeGiteaMysqlClaim existingClaim: MyAwesomeGiteaMysqlClaim
``` ```
### Admin User ### Admin User
@ -382,11 +382,11 @@ not possible to delete an admin user after it has been created. This has to be
done in the ui. You cannot use `admin` as username. done in the ui. You cannot use `admin` as username.
```yaml ```yaml
gitea: gitea:
admin: admin:
username: "MyAwesomeGiteaAdmin" username: "MyAwesomeGiteaAdmin"
password: "AReallyAwesomeGiteaPassword" password: "AReallyAwesomeGiteaPassword"
email: "gi@tea.com" email: "gi@tea.com"
``` ```
You can also use an existing Secret to configure the admin user: You can also use an existing Secret to configure the admin user:
@ -404,8 +404,8 @@ stringData:
```yaml ```yaml
gitea: gitea:
admin: admin:
existingSecret: gitea-admin-secret existingSecret: gitea-admin-secret
``` ```
### LDAP Settings ### LDAP Settings
@ -416,20 +416,20 @@ All LDAP values from <https://docs.gitea.io/en-us/command-line/#admin> are avail
Multiple LDAP sources can be configured with additional LDAP list items. Multiple LDAP sources can be configured with additional LDAP list items.
```yaml ```yaml
gitea: gitea:
ldap: ldap:
- name: MyAwesomeGiteaLdap - name: MyAwesomeGiteaLdap
securityProtocol: unencrypted securityProtocol: unencrypted
host: "127.0.0.1" host: "127.0.0.1"
port: "389" port: "389"
userSearchBase: ou=Users,dc=example,dc=com userSearchBase: ou=Users,dc=example,dc=com
userFilter: sAMAccountName=%s userFilter: sAMAccountName=%s
adminFilter: CN=Admin,CN=Group,DC=example,DC=com adminFilter: CN=Admin,CN=Group,DC=example,DC=com
emailAttribute: mail emailAttribute: mail
bindDn: CN=ldap read,OU=Spezial,DC=example,DC=com bindDn: CN=ldap read,OU=Spezial,DC=example,DC=com
bindPassword: JustAnotherBindPw bindPassword: JustAnotherBindPw
usernameAttribute: CN usernameAttribute: CN
publicSSHKeyAttribute: publicSSHKey publicSSHKeyAttribute: publicSSHKey
``` ```
You can also use an existing secret to set the bindDn and bindPassword: You can also use an existing secret to set the bindDn and bindPassword:
@ -474,11 +474,11 @@ Multiple OAuth2 sources can be configured with additional OAuth list items.
```yaml ```yaml
gitea: gitea:
oauth: oauth:
- name: 'MyAwesomeGiteaOAuth' - name: "MyAwesomeGiteaOAuth"
provider: 'openidConnect' provider: "openidConnect"
key: 'hello' key: "hello"
secret: 'world' secret: "world"
autoDiscoverUrl: 'https://gitea.example.com/.well-known/openid-configuration' autoDiscoverUrl: "https://gitea.example.com/.well-known/openid-configuration"
#useCustomUrls: #useCustomUrls:
#customAuthUrl: #customAuthUrl:
#customTokenUrl: #customTokenUrl:
@ -502,7 +502,7 @@ stringData:
```yaml ```yaml
gitea: gitea:
oauth: oauth:
- name: 'MyAwesomeGiteaOAuth' - name: "MyAwesomeGiteaOAuth"
existingSecret: gitea-oauth-secret existingSecret: gitea-oauth-secret
... ...
``` ```
@ -893,9 +893,9 @@ automatically in certain situations:
configuration nor via auto generation. We explicitly prevent to set new secrets. configuration nor via auto generation. We explicitly prevent to set new secrets.
> 💡 It would be possible to set new secret keys manually by entering > 💡 It would be possible to set new secret keys manually by entering
the running container and rewriting the app.ini by hand. However, this it is > the running container and rewriting the app.ini by hand. However, this it is
not advisable to do so for existing installations. Certain settings like > not advisable to do so for existing installations. Certain settings like
_LDAP_ would not be readable anymore. > _LDAP_ would not be readable anymore.
#### Probes #### Probes