CargoLifter

This project offers an implementation of an alternate registry. Instead of having it's own auth mechanism it uses existing source control providers logins. Those are:

• Github
• Gitlab
• Gitea (e.g. codederg)

CargoLifter uses access tokens for interacting with the backend. So each action will be impersonated. This of course requires write access and this is the way to limit.

Cargo Login

Github

Use a combination of username and personal access token like this: <username>:<token>

Gitlab

Use your gitlab access token as cargo login token.

Configuration

Configuration is done via a JSON config file.

Service

"web": {
    "port": 8080
}

Storage

FileSystem storage configuration:

"storage": {
    "FileSystem": {
        "path": "<path>"
    }
}

S3 storage configuration (you may omit the credentials for S3 access as it will default to the environment variables):

"storage": {
    "S3": {
        "bucket": "<bucket name>",
        "credentials": {
            "access_key": "<access key>",
            "secret_key": "<secret key>",
            "secret_token": "<optional secret token>",
        }
    }
}

Files that are mirrored will automatically put in a subfolder called mirror.

Backend

Github configuration:

"backend": {
    "Github": {
        "owner": "<username>",
        "repo": "<repository>",
        "host": "<for future when hosting custom instance>",
        "cargolifter_token": "<a token to use to merge pull requests>",
        "default_branch": "<default to main>"
    }
}

Gitlab configuration:

"backend": {
    "Gitlab": {
        "project_id": "<project id>",
        "host": "<hosting custom instance>",
        "cargolifter_token": "<a token to use to merge pull requests>",
        "default_branch": "<default to main>"
    }
}

The registry git repository must contain a prefilled config.json containing on both cases:

{
    "dl": "http://<hostname>:<port>/api/v1/crates",
    "api": "http://<hostname>:<port>"
}

Example Config

{
    "backend": {
        "Github": {
            "owner": "cemoktra",
            "repo": "my-private-crates",
        }
    },
    "web": {
        "port": 8080
    },
    "storage": {
        "FileSystem": {
            "path": "./test/storage"
        }
    }
}