Open source, MIT

Folder and file permissions for self-hosted GitLab CE

vela lets you decide which users and groups can view, read or write each path in a project, without paying for a higher GitLab tier. Turning it on changes nothing until you add a rule, and it can only take access away, never give more than GitLab already allows.

Three levels on any file or folder

You give each user or group up to three levels. Each level includes the one before it.

  • View

    see that the path exists in file lists

  • Read

    open the file and see its contents

  • Write

    create, change, rename or delete it

A folder rule covers everything inside it, a rule on a single file beats the folder around it, and an explicit deny always wins. Instance admins and project Owners are never locked out.

Two tiers, so it works on any GitLab CE

Tier A, server hook

Enforces writes on any CE version and install method (Linux package, Docker, source, Helm), using only the global pre-receive server hooks GitLab documents. It lives outside GitLab's files, so it survives upgrades.

Tier B, overlay

Everything in Tier A, plus hiding paths in the web UI, API, search and diffs, and a settings page under Project Settings. It relies on GitLab internals, so it refuses to boot if GitLab changed something it needs.

Why there are two tiers

The one limit you must know about

vela does not stop git clone or git fetch.

Write rules are enforced: a push that touches a path the person may not change is rejected. View and Read rules only hide things inside GitLab. Anyone who can clone the repository has every file and the full history. Commit history, source downloads, compare pages and project export are not filtered either. To keep a folder secret, put it in its own project.

Keeping a folder out of everyone's clone

Tested versions

Every result below is a live run of the end-to-end suite against a real GitLab CE container. Only versions with green results are listed as tested.

Tier A, server hook
23 of 23 live cases on GitLab CE 15.11 to 19.5
Tier B, overlay
68 of 68 on 16.11 to 19.5, and 69 of 69 on 15.11
In-place upgrade
19.0.2 to 19.0.11 in Docker, overlay 68 of 68 after the upgrade
Not tested
source installs, Helm, Gitaly Cluster (Praefect)

All compatibility results

Support the work

Sponsor vela

vela is free under MIT. Sponsoring pays for testing on more GitLab versions, bug fixes and the next release. Even $1 a month helps.

Sponsor on GitHub

Work with Avytrix

vela is built and maintained by Avytrix Technologies. We also build custom software, set up GitLab and CI, and maintain the open source we publish.

Tell us about your project