gitea-group-sync/README.md

62 lines
1.6 KiB
Markdown

# Gitea Group Sync
This application adds users to appropriate teams in Gitea based on group membership information in LDAP.
Docker image available at [ghcr.io/gitea-group-sync/gitea-group-sync](https://github.com/gitea-group-sync/gitea-group-sync/pkgs/container/gitea-group-sync).
## Installation instructions
You must have configured your LDAP with gitea
Here I will give the settings for a simple [LDAP](https://github.com/rroemhild/docker-test-openldap), you can configure by changing the code as you like
If you configured the [Gitea](https://hub.docker.com/r/gitea/gitea) <=> [LDAP](https://github.com/rroemhild/docker-test-openldap) connection correctly, you should have users
![](images/Image1.png)
You need to create Manage Access Tokens and add key to run.sh or docker-compose.yml the configuration file
##### Configuration:
There are two ways to configure the application. Via YAML Configuration File or Enviroment Variables.
- See `run.sh` for an example using the enviroment Variables.
- Use `./gitea-group-sync --config="config.yaml"` with the example Config File for the YAML Variant.
##### Gitea Tokens
The application supports several keys, since to add people to the group you must be the owner of the organization.
![](images/Image2.png)
#### create organizations in gitea
![](images/Image3.png)
#### add the appropriate groups in our case: ship_crew, admin_staff
![](images/Image4.png)
### Usage
REP_TIME: '@every 1m' -- you can change the synchronization time of groups
```
docker-compose up
```
or
```
./run.sh
```
![](images/Image8.png)
### Realise
![](images/Image5.png)
![](images/Image6.png)
![](images/Image7.png)