2023-04-21 06:56:06 +00:00
# convention 4 kubernetes: c4k-forgejo
[![Clojars Project ](https://img.shields.io/clojars/v/org.domaindrivenarchitecture/c4k-forgejo.svg )](https://clojars.org/org.domaindrivenarchitecture/c4k-forgejo) [![pipeline status ](https://gitlab.com/domaindrivenarchitecture/c4k-forgejo/badges/master/pipeline.svg )](https://gitlab.com/domaindrivenarchitecture/c4k-forgejo/-/commits/main)
2022-06-07 15:37:21 +00:00
2024-08-06 11:03:04 +00:00
[<img src="https://domaindrivenarchitecture.org/img/delta-chat.svg" width=20 alt="DeltaChat"> chat over e-mail ](mailto:buero@meissa-gmbh.de?subject=community-chat ) | [<img src="https://meissa.de/images/parts/contact/mastodon36_hue9b2464f10b18e134322af482b9c915e_5501_filter_14705073121015236177.png" width=20 alt="M"> meissa@social.meissa-gmbh.de ](https://social.meissa-gmbh.de/@meissa ) | [Blog ](https://domaindrivenarchitecture.org ) | [Website ](https://meissa.de )
2022-06-07 15:37:21 +00:00
## Purpose
2023-04-21 06:56:06 +00:00
c4k-forgejo provides a k8s deployment file for forgejo containing:
* forgejo
2023-06-30 15:34:27 +00:00
* test federated forgejo
2022-06-07 15:37:21 +00:00
* ingress having a letsencrypt managed certificate
* postgres database
2023-04-21 06:56:06 +00:00
* encrypted backup on S3 & restore
* monitoring on graphana-cloud
2022-06-07 15:37:21 +00:00
2024-02-20 17:33:04 +00:00
c4k-forgejo is an example how to create efficient k8s one shot deployments with https://repo.prod.meissa.de/meissa/c4k-common.
2022-06-07 15:37:21 +00:00
## Try out
Click on the image to try out live in your browser:
2023-04-21 06:56:06 +00:00
[![Try it out ](doc/tryItOut.png "Try out yourself" )](https://domaindrivenarchitecture.org/pages/dda-provision/c4k-forgejo/)
2022-06-07 15:37:21 +00:00
Your input will stay in your browser. No server interaction is required.
2023-04-21 06:56:06 +00:00
## Forgejo setup
2022-06-07 15:37:21 +00:00
2023-04-21 06:56:06 +00:00
After having deployed the yaml-file generated by the c4k-forgejo module you need to complete the setup for forgejo:
2022-06-11 17:34:43 +00:00
2023-04-21 06:56:06 +00:00
* Open the URL of your forgejo-server, and you will be shown a configuration page.
2022-07-23 10:12:24 +00:00
* Adjust the settings according to your needs
* Add the administrator's data (name, password and email) and submit the page.
2023-04-21 06:56:06 +00:00
* The required database will be created and the forgejo setup will be completed.
2022-07-23 10:12:24 +00:00
* The SSH-URL for a repo has the format: "ssh://git@domain:2222/[username]/[repo].git
2023-04-21 06:56:06 +00:00
Example: "git clone ssh://git@repo.test.meissa.de:2222/myuser/c4k-forgejo.git"
2022-06-07 15:37:21 +00:00
2024-07-09 07:25:24 +00:00
### Add Impressum
In order to customize the UI e.g. for adding an Impressum, see the [Forgejo Docs ](https://forgejo.org/docs/latest/developer/customization/#adding-links-and-tabs ).
The individually needed files have to be added by hand into the directory `/data/gitea/templates/custom/` in the forgejo Pod. Since a PV is mounted under `/data` , these ui customizations are persisted.
2023-04-22 09:54:13 +00:00
## Development & mirrors
Development happens at: https://repo.prod.meissa.de/meissa/c4k-forgejo
Mirrors are:
2024-08-05 06:58:14 +00:00
* https://codeberg.org/meissa/c4k-forgejo (Issues and PR)
2024-01-26 14:06:45 +00:00
* https://gitlab.com/domaindrivenarchitecture/c4k-forgejo (CI)
* https://github.com/DomainDrivenArchitecture/c4k-forgejo
2023-04-22 09:54:13 +00:00
For more details about our repository model see: https://repo.prod.meissa.de/meissa/federate-your-repos
2022-06-07 15:37:21 +00:00
## License
2024-08-05 06:58:14 +00:00
Copyright © 2023, 2024 meissa GmbH
2022-06-07 15:37:21 +00:00
Licensed under the [Apache License, Version 2.0 ](LICENSE ) (the "License")
Pls. find licenses of our subcomponents [here ](doc/SUBCOMPONENT_LICENSE )