https://github.com/canonical/candid

Identity Manager Service
https://github.com/canonical/candid

Last synced: 3 months ago
JSON representation

Identity Manager Service

• Host: GitHub
• URL: https://github.com/canonical/candid
• Owner: canonical
• License: agpl-3.0
• Created: 2020-03-10T09:23:11.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-23T10:06:42.000Z (11 months ago)
• Last Synced: 2024-04-10T05:28:12.555Z (10 months ago)
• Language: Go
• Size: 2.43 MB
• Stars: 42
• Watchers: 12
• Forks: 29
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - canonical/candid - Identity Manager Service (Go)

README

        
# Candid Identity service

The Candid server provides a macaroon-based authentication service.

## Installation

The easiest way to start using the candid service is with the snap:

    snap install candid

The configuration file used by the snap can be found in

`/var/snap/candid/current/config.yaml`.

## Development

### Requirements

Candid requires go1.11 or later to build. This is available in the go snap:

    snap install go

Go will additionally require installing the following packages in order

that it can fetch and build candid dependencies:

    apt install build-essential bzr git

### Source

Get the source from `github.com/canonical/candid`.

    git clone https://github.com/canonical/candid

It is recommended that you check out the source outside of any `$GOPATH`

(`$HOME/go` by default). If you do wish to check out into a `$GOPATH`

then you will need to set the environment variable `GO111MODULE=on`.

### Testing

The `store/mgostore` component additionally requires a running mongodb

server, this may be running on a different system. The location of the

mongodb server should be specified in an environment variable called

`MGOCONNECTIONSTRING`, if this does not exist then the standard

port (27017) on localhost will be assumed. To disable testing of

`store/mgostore` completely then set the environment variable

`MGOTESTDISABLE=1`.

The `store/sqlstore` component additionally requires a running

postgresql, this may be running on a different system. The posgresql

system to use is specified using the standard postgresql [environment

variables](https://www.postgresql.org/docs/10/static/libpq-envars.html).

To skip running postgresql tests set the environment variable

`PGTESTDISABLE=1`.

Tests are run by running make check in the root of the source tree. The

tests for a single package can be run by running `go test` in the

package directory.