Contents
Using Hermine
Installing Hermine for production
Getting the code
Docker Compose
Hermine Docker image
Manual install
OAuth
Health check
Getting started
Main concepts used
Main questions Hermine helps you answer
Manual workflow
Defining a FOSS policy
Global characteristics of licenses
Authorized contexts and specific derogations
Obligations and compliance actions
Reference data
Generic principles
Importing Community Data into your Hermine Server
Interacting with reference data in your Hermine instance
REST API
Authentication via Token
Uploading a BOM file
Checking the validation steps
JUnit
Endpoints for compliance actions
Generic API endpoints for Models
Developing Hermine
Basic development workflow
Standard install
Working with DevContainer
Coding standards
Developer Certificate of Origin
REUSE standard
Code linting
Naming conventions
Commit messages
The Data Model
Models for license management
Models for validation rules
Models for internal product management
Models for 3rd party components
Permissions
Permissions used by Hermine
Groups
Custom tags for Django templates
licenseAllowedCSS()
licenseCopyleftCSS()
licenseFOSSCSS()
licenseReviewCSS()
Tests
Running the tests
Coverage
Monitoring performances
Hermine
Index
Index
A
|
C
|
D
|
E
|
F
|
G
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
AbstractComponentRule (class in cube.models.policy)
AbstractUsageRule (class in cube.models.policy)
C
Category (class in cube.models.products)
Category.DoesNotExist
Category.MultipleObjectsReturned
Compatibility (class in cube.models.licenses)
Compatibility.DoesNotExist
Compatibility.MultipleObjectsReturned
Component (class in cube.models.components)
Component.DoesNotExist
Component.MultipleObjectsReturned
cube.models.components
module
cube.models.licenses
module
cube.models.policy
module
cube.models.products
module
cube.templatetags.cube_tags
module
D
Derogation (class in cube.models.policy)
Derogation.DoesNotExist
Derogation.MultipleObjectsReturned
E
Exploitation (class in cube.models.products)
Exploitation.DoesNotExist
Exploitation.MultipleObjectsReturned
Exploitation.Usage (class in cube.models.products)
Exploitation.Usage.DoesNotExist
Exploitation.Usage.MultipleObjectsReturned
F
Funding (class in cube.models.components)
Funding.DoesNotExist
Funding.MultipleObjectsReturned
G
Generic (class in cube.models.licenses)
Generic.DoesNotExist
Generic.MultipleObjectsReturned
L
License (class in cube.models.licenses)
License.DoesNotExist
License.MultipleObjectsReturned
licenseAllowedCSS() (in module cube.templatetags.cube_tags)
LicenseChoice (class in cube.models.policy)
LicenseChoice.DoesNotExist
LicenseChoice.MultipleObjectsReturned
licenseCopyleftCSS() (in module cube.templatetags.cube_tags)
LicenseCuration (class in cube.models.policy)
LicenseCuration.DoesNotExist
LicenseCuration.MultipleObjectsReturned
licenseFOSSCSS() (in module cube.templatetags.cube_tags)
LicensePolicy (class in cube.models.licenses)
LicensePolicy.DoesNotExist
LicensePolicy.MultipleObjectsReturned
licenseReviewCSS() (in module cube.templatetags.cube_tags)
licenses (cube.models.components.Version property)
M
module
cube.models.components
cube.models.licenses
cube.models.policy
cube.models.products
cube.templatetags.cube_tags
O
Obligation (class in cube.models.licenses)
Obligation.DoesNotExist
Obligation.MultipleObjectsReturned
P
Product (class in cube.models.products)
Product.DoesNotExist
Product.MultipleObjectsReturned
R
Release (class in cube.models.products)
Release.DoesNotExist
Release.MultipleObjectsReturned
S
save() (cube.models.components.Version method)
(cube.models.policy.AbstractComponentRule method)
T
Team (class in cube.models.licenses)
Team.DoesNotExist
Team.MultipleObjectsReturned
U
Usage (class in cube.models.components)
Usage.DoesNotExist
Usage.MultipleObjectsReturned
V
Version (class in cube.models.components)
Version.DoesNotExist
Version.MultipleObjectsReturned