Gitea Advanced LDAP User/Group Sync

This application is designed to sync LDAP users, groups (orgs and teams) and user membership to Gitea.

It can do the following:

• Create (and optionally delete) Gitea Users based on LDAP users.
• Create (and optionally delete) Gitea Organizations based on LDAP groups.
• Create (and optionally delete) Gitea Teams inside Organizations based on LDAP subgroups.
• Attach existing Gitea Users to appropriate Gitea Teams based on group membership information in LDAP.

The application is not going to sync users from LDAP to Gitea as Gitea provides a solution for that.

This application syncs users as well. We suggest to disable Gitea LDAP user sync (but you can still use Gitea's LDAP Provider).

Docker image available at ghcr.io/janosmiko/gitea-ldap-sync.

Usage

Docker Compose

Configure your settings in docker-compose.yml or copy config.yaml.sample as config.yaml and fill the settings (and uncomment the volume mount in docker-compose.yml`.

docker-compose up -d

Kubernetes

Modify the values in deploy/secret.yaml and deploy/job.yaml and apply them to Kubernetes.

kubectl apply -f deploy/secret.yaml
kubectl apply -f deploy/deployment.yaml

Configuration Options

You can configure the application using a yaml config file (find a sample in this repository) or using Environment Variables.

Available Environment Variables (find example values in config.yaml.sample):

Variable	Description	Default
DEBUG	Enable debug mode	false
GITEA_BASE_URL	Gitea baseURL in https://[email protected] format.	""
GITEA_TOKEN	Gitea admin user token	""
LDAP_URL	LDAP connection URL	""
LDAP_PORT	LDAP connection port	389
LDAP_USE_TLS	Enable TLS connection for LDAP	true
LDAP_ALLOW_INSECURE_TLS	Allow insecure TLS connections (disable cert verification)	false
LDAP_BIND_DN	LDAP Bind DN (or username)	""
LDAP_BIND_PASSWORD	LDAP Bind Password	""
LDAP_USER_SEARCH_BASE	LDAP User Search Base	""
LDAP_USER_FILTER	LDAP User Filter	""
LDAP_USER_USERNAME_ATTRIBUTE	LDAP attribute for Gitea User Username	"sAMAccountName"
LDAP_USER_FULLNAME_ATTRIBUTE	LDAP attribute for Gitea User Fullname	"cn"
LDAP_USER_FIRST_NAME_ATTRIBUTE	LDAP attribute for Gitea User First Name (first + sur = full)	""
LDAP_USER_SURNAME_ATTRIBUTE	LDAP attribute for Gitea User Surname	""
LDAP_USER_EMAIL_ATTRIBUTE	LDAP attribute for Gitea User Email	"mail"
LDAP_USER_PUBLIC_SSH_KEY_ATTRIBUTE	LDAP attribute for Gitea User SSH Key	"sshPublicKey"
LDAP_USER_AVATAR_ATTRIBUTE	LDAP attribute for Gitea User Avatar	"avatar"
LDAP_EXCLUDED_USERS	Exclude users from sync (separated by whitespace)	"root"
LDAP_EXCLUDED_USERS_REGEX	Exclude users from sync (regular expression)	""
LDAP_ADMIN_FILTER	LDAP attribute for Gitea User Avatar	""
LDAP_RESTRICTED_FILTER	LDAP attribute for Gitea User Avatar	""
LDAP_GROUP_SEARCH_BASE	LDAP Group Search Base (Gitea Organizations)	""
LDAP_GROUP_FILTER	LDAP Group Filter	""
LDAP_GROUP_NAME_ATTRIBUTE	LDAP attribute for Gitea Organization Name	"cn"
LDAP_GROUP_FULLNAME_ATTRIBUTE	LDAP attribute for Gitea Organization Fullname	"cn"
LDAP_GROUP_DESCRIPTION_ATTRIBUTE	LDAP attribute for Gitea Organization Description	"cn"
LDAP_SUBGROUP_SEARCH_BASE	LDAP Subgroup Search Base (Gitea Teams)	""
LDAP_SUBGROUP_FILTER	LDAP Subgroup filter	""
LDAP_SUBGROUP_NAME_ATTRIBUTE	LDAP attribute for Gitea Team Name	"cn"
LDAP_SUBGROUP_DESCRIPTION_ATTRIBUTE	LDAP attribute for Gitea Team Description	"cn"
LDAP_EXCLUDE_GROUPS	Exclude groups from sync (separated by whitespace)	""
LDAP_EXCLUDE_GROUPS_REGEX	Exclude groups from sync (regular expression)	""
LDAP_EXCLUDE_SUBGROUPS	Exclude subgroups from sync (separated by whitespace)	""
LDAP_EXCLUDE_SUBGROUPS_REGEX	Exclude groups from sync (regular expression)	""
LDAP_TRIM_PARENT_NAME	Trim parent name from subgroup name	false
LDAP_SUBGROUP_SEPARATOR	Trim parent name from subgroup name by this separator	"/"
CRON_TIMER	Configure the schedule of the sync (cron format)	"@every 1m"
SYNC_CONFIG_CREATE_GROUPS	Create non-existing groups in Gitea.	true
SYNC_CONFIG_FULL_SYNC	Delete groups from Gitea if they are not existing in LDAP	false

Additional settings for creating Organizations and Teams in Gitea:

• SYNC_CONFIG_DEFAULTS_ORGANIZATION_REPO_ADMIN_CHANGE_TEAM_ACCESS
• SYNC_CONFIG_DEFAULTS_ORGANIZATION_VISIBILITY
• SYNC_CONFIG_DEFAULTS_TEAM_CAN_CREATE_ORG_REPO
• SYNC_CONFIG_DEFAULTS_TEAM_INCLUDES_ALL_REPOSITORIES
• SYNC_CONFIG_DEFAULTS_TEAM_PERMISSION
• SYNC_CONFIG_DEFAULTS_TEAM_UNITS

License

This work is licensed under the MIT license. See LICENSE file for details.

Acknowledgement

This project is based on the idea by Gitea Group Sync by TWS Inc .