Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): Add docs from main sw360
- Added administrator guide - Modified icons from doc Reference: #10 Signed-off-by: Helio Chissini de Castro <heliocastro@gmail.com>
- Loading branch information
1 parent
12580b0
commit c61ddf9
Showing
6 changed files
with
98 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: "Administration Guide" | ||
linkTitle: "Administration Guide" | ||
weight: 11 | ||
icon: fas fa-tools | ||
description: SW360 Administration Guides | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
linkTitle: "Administrator Menu" | ||
title: "Administrator Menu" | ||
weight: 10 | ||
--- | ||
|
||
The **admin menu** consists of the following items: | ||
|
||
{{< figure src="/img/ImagesBasic/admin_menu.png">}} | ||
|
||
- **User**: Displays the list of **Liferay Users**. One can also download or upload new users in this section | ||
|
||
- **Vendors**: Displays the list of the **Vendors** that can be managed by the admin | ||
|
||
- **Bulk License Edit**: List of licenses can be edited together in this section | ||
|
||
- **Licenses**: Functions such as Download License Archive, Upload License Archive, Import SPDX Information and Delete License Information can be done in this section | ||
|
||
- **Obligations**: To manage different types of Obligations on the basis of obligation level and obligation type | ||
|
||
- **Schedule**: To schedule tasks such as CVE Search | ||
|
||
- **Fosology**: Connection to the Fossology server | ||
|
||
- **Import and Export**: Can Import and Export **Component**, **Release** and **License** information | ||
|
||
- **Attachment Cleanup**: To cleanup attachment database | ||
|
||
- **Database Sanitization**: Helps in searching for duplicate identifiers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
linkTitle: "Properties" | ||
title: "Properties" | ||
weight: 12 | ||
--- | ||
|
||
**Frontend Properties**: All the sw360 frontend properties are mentioned in [sw360.properties](https://github.com/eclipse/sw360/blob/master/frontend/sw360-portlet/src/main/resources/sw360.properties) file. | ||
For example; | ||
|
||
- Different categories for components, | ||
|
||
component.categories=[ "framework", "SDK", "big-data", "build-management", "cloud", "content", "database", "graphics", "http", "javaee", "library", "mail", "mobile", "network-client", "network-server", "osgi", "security", "testing", "virtual-machine", "web-framework", "xml"] | ||
|
||
- Dropdown for project type, | ||
|
||
project.type=[ "Customer Project", "Internal Project", "Product", "Service", "Inner Source" ] | ||
|
||
- API Token generation, | ||
|
||
rest.apitoken.generator.enable=false | ||
|
||
- Activation of portlets and components | ||
|
||
**Backend Properties**: This, [sw360.properties](https://github.com/eclipse/sw360/blob/master/backend/src-common/src/main/resources/sw360.properties) file contains the sw360 backend properties. This file contains the common properties for the backend services and also holds the setting for the mail utility. | ||
|
||
You can change these default values by mentioning it in the sw360.properties file, present in /etc/sw360 folder. This path is to be created by the admin. After changing the properties, server needs to be restarted in order to make the changes effective. If the properties file is not present in the required folder, the default values will be selected. |
35 changes: 35 additions & 0 deletions
35
content/en/docs/AdministrationGuide/user-management-roles.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
linkTitle: "User Management Roles" | ||
title: "User Management Roles" | ||
weight: 11 | ||
--- | ||
|
||
Every user can create records and edit own created records. However, to change records of others, approval is required. Approval in SW360 is a so called moderation request. A moderation request is a set of proposed changed not applied to record immediately, but will be routed to; | ||
|
||
- The creator of the record | ||
- The moderators for a record | ||
- The clearing admins of the same group in SW360. | ||
|
||
Then, the proposed changes can be approved by them. | ||
|
||
## General SW360 Roles and Access | ||
|
||
There are two main types of roles. The first type are general roles on the system that apply in the default case: | ||
|
||
1. **User** - A user is the default, in order to apply modifications, a user can pose moderation requests, except for the data items that a user has created. | ||
2. **Clearing Expert** - Member of the clearing team. Has the rights to work on the projects of the own group and to edit licenses. Can also work on clearing requests. | ||
3. **Clearing Admin** - A clearing admin has the rights to work on the projects of the own group and to edit licenses. | ||
4. **ECC Admin** - The only users who can edit (or approve as moderation request) ECC classifications. | ||
5. **Secuirty Admin** - The only users to edit relevance for security vulnerabilities. | ||
6. **SW360 Admin** - An admin has full rights on all (visible!) data items. Can elevate permissions of other users. | ||
|
||
In addition there are ACL-style roles, meaning that per data item access settings can be made: | ||
|
||
1. **Creator** - A creator can modify in addition to the user's read abilities, a user can be creator of a data item. | ||
2. **Moderator** - A creator can define moderators for a data item. Moderators can change a data item as a creator can. | ||
3. **Contributor** (Component) - Is a contributor to a component, project, similar (but not the same) to a moderator. In addition to moderator, this role has been added to identify contributors (or that contributors get the fame). In contrast, the contributor cannot delete data items. | ||
4. **Project Owner** - A user who owns the project. | ||
5. **Lead Architect** (Project) - Is a contributor, just named differently to identify the responsible person. an architect refers to the person who has that role of the project or product. This role has been added to identify architects to have a contact person for technical questions. | ||
6. **Project Responsible** (Project) - Is a contributor, just named differently to identify the responsible person. | ||
7. **Security Responsible** - Users responsible for the security of the project. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.