Skip to content

patrickoppel/ktra

 
 

Repository files navigation

!!! Fork !!!

This fork allows users to share a registry via Github repo only, no server needed. Every team member can run Ktra locally. For set-up see Documentations.

Ktra 🚚 ktra at crates.io

Your Little Cargo Registry.

Ktra is an implementation of the Alternate Registry that is introduced for non-public crates in Rust/Cargo 1.34.

In other words, Ktra is an all-in-one package for the private cargo registry.

Documentations

Please follow the instructions in The Ktra Book for introduction and quick start guide.

Attention

Additional set-up is required when sharing a registry via github alone. This should be done before publishing the crate for the first time.

  • add repository key in your crates Cargo.toml, see example:
[package]
name = "ktra"
version = "0.7.0"
authors = ["moriturus <[email protected]>"]
edition = "2018"
license = "MIT OR Apache-2.0"
description = "Your Little Cargo Registry"
repository = "https://github.com/moriturus/ktra"
  • add workflows-release.yml as .github/workflows/release.yml in your crate's repo

Docker images

docker pull ghcr.io/moriturus/ktra:latest

All of the docker images are stored at GitHub Container Registry.
These are public images so you can pull them without any authentication.

Any commit on develop branch builds images listed below:

  • latest
    • db-sled featured image.
  • openid-latest
    • db-sled featured image.
    • openid support for authentication
  • db-redis-latest
    • db-redis featured image.
  • db-redis-openid-latest
    • db-redis featured image.
    • openid support for authentication
  • db-mongo-latest
    • db-mongo featured image.
  • db-mongo-openid-latest
    • db-mongo featured image.
    • openid support for authentication

Similarly, images below are built automatically when tags are pushed:

  • {VERSION} (e.g. 0.4.3)
    • db-sled featured image.
  • openid-{VERSION}
    • db-sled featured image.
    • openid support for authentication
  • db-redis-{VERSION}
    • db-redis featured image.
  • db-redis-openid-{VERSION}
    • db-redis featured image.
    • openid support for authentication
  • db-mongo-{VERSION}
    • db-mongo featured image.
  • db-mongo-openid-{VERSION}
    • db-mongo featured image.
    • openid support for authentication

Please see "Installation: Docker" page in The Ktra Book for more details.

Features

Current

From 0.1.0

  • Minimum Alternate Registry implementation.
  • Sled as its internal database.
    • via db-sled feature turned on by default.
  • Almost pure Rust.

From 0.2.0

  • Secure user management.

From 0.4.0

  • Redis support.
    • via db-redis feature.

From 0.4.2

  • MongoDB support.
    • via db-mongo feature.

From 0.5.0

From 0.7.0

  • OpenID support for auto-discoverable identity providers (e.g. Gitlab, not Github)

Planned

And any feature requests are welcome!

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

About

Your Little Cargo Registry

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • Rust 97.1%
  • Shell 1.8%
  • Dockerfile 1.1%