Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Skalli/User Guide"
m (→How to Implement Extensions) |
m |
||
| Line 15: | Line 15: | ||
Various configuration settings can be managed via REST API calls. | Various configuration settings can be managed via REST API calls. | ||
| − | (There is a good Firefox add-in for that: | + | (There is a good Firefox add-in for that: [https://addons.mozilla.org/en-US/firefox/addon/9780/ RESTClient]) |
If you do not know how to obtain the ''Skalli'' sources and how to start it, please visit [[Skalli/Contributor_Guide|Contributor Guide]] first. | If you do not know how to obtain the ''Skalli'' sources and how to start it, please visit [[Skalli/Contributor_Guide|Contributor Guide]] first. | ||
| Line 21: | Line 21: | ||
== The Workdir == | == The Workdir == | ||
| − | The working directory of Skalli is the place data is stored. | + | The working directory of Skalli is the place where all data is stored. |
| − | In the | + | In the subdirectory ''storage'' Skalli persists information about projects, favorites, issues, users etc. |
| + | Customization settings are stored in the subdirectory ''customization''. | ||
| − | The ''workdir'' can be | + | The ''workdir'' can be specified |
| − | # property ''workdir'' in configuration file ''/skalli.properties'' | + | # by defining a property ''workdir'' in the configuration file ''/skalli.properties'' (value is the absolute path of the working directory) |
| − | # system property ''workdir=<path-to- | + | # by defining the system property ''workdir=<path-to-working-directory>'' |
| − | If ''workdir'' is not set | + | If ''workdir'' is not set explicitly the current directory is used as default. |
== Using the Local User Store == | == Using the Local User Store == | ||
| − | ''Skalli'' is able to use LDAP for user management. If you want to use | + | ''Skalli'' is able to use LDAP for user management. If you want to use a local user store instead the LDAP user service in Skalli has to be disabled. |
| − | + | Open the OSGi console and type ''ls''. Search for a service with the name ''org.eclipse.skalli.core.user.ldap'' and stop it (''disable <ID>''). Search for the service with name ''org.eclipse.skalli.core.user.local'' and start it (''enable <ID>''). | |
| − | + | ||
| − | Users are stored in the directory ''<workdir>/storage/User''. | + | Users are stored in the directory ''<workdir>/storage/User''. Each user is persisted in a separate XML file named ''<userId>.xml'' in this directory. |
| − | Each user is persisted in | + | |
| − | Example | + | Example of a ''<userId>.xml'' file: |
<source lang="xml"> | <source lang="xml"> | ||
<org.eclipse.skalli.common.User> | <org.eclipse.skalli.common.User> | ||
| Line 58: | Line 57: | ||
</source> | </source> | ||
| − | Note that | + | Note that ''userId'' must be the id of an authenticated user of your web container (Jetty, Tomcat etc.). For example, in Jetty you can define user ids in ''etc/realm.properties''. |
== Configuring Administrator Users == | == Configuring Administrator Users == | ||
| − | + | Skalli administrators are allowed to do more than normal users, eg. they are allowed to: | |
| − | + | * edit all projects | |
| − | + | * delete projects | |
| − | * | + | * see issues for all projects |
| − | * see | + | * configure a Skalli instance |
| − | + | Skalli adds the command ''admin'' to the OSGI console that allows to ''list'', ''add'' and ''remove'' Skalli administrators: | |
<source lang="text"> | <source lang="text"> | ||
skalli admin [-list] [-add <admin_id>] [-remove <admin_id>] - maintain set of user with administrative permissions | skalli admin [-list] [-add <admin_id>] [-remove <admin_id>] - maintain set of user with administrative permissions | ||
</source> | </source> | ||
| − | If you for example want to add the user ''skalliadmin'' to the administrators | + | If you for example want to add the user ''skalliadmin'' to the group of administrators type |
<source lang="text"> | <source lang="text"> | ||
osgi> skalli admin -add skalliadmin | osgi> skalli admin -add skalliadmin | ||
| Line 79: | Line 78: | ||
Administrators are persisted in the directory ''<workdir>/storage/Group''. | Administrators are persisted in the directory ''<workdir>/storage/Group''. | ||
| + | |||
= Terms = | = Terms = | ||
Revision as of 11:33, 16 May 2011
Contents
Getting Started
Tutorials
How to Implement Skalli Extensions
You can write your own extension. A Skalli extension are all display & application logic elements needed to provide a specific functionality. You can simply bring Skalli to visualise their information.
Find out how to write your extension:
Configuration
There are different configuration possibilities for Skalli.
Various configuration settings can be managed via REST API calls. (There is a good Firefox add-in for that: RESTClient)
If you do not know how to obtain the Skalli sources and how to start it, please visit Contributor Guide first.
The Workdir
The working directory of Skalli is the place where all data is stored.
In the subdirectory storage Skalli persists information about projects, favorites, issues, users etc. Customization settings are stored in the subdirectory customization.
The workdir can be specified
- by defining a property workdir in the configuration file /skalli.properties (value is the absolute path of the working directory)
- by defining the system property workdir=<path-to-working-directory>
If workdir is not set explicitly the current directory is used as default.
Using the Local User Store
Skalli is able to use LDAP for user management. If you want to use a local user store instead the LDAP user service in Skalli has to be disabled.
Open the OSGi console and type ls. Search for a service with the name org.eclipse.skalli.core.user.ldap and stop it (disable <ID>). Search for the service with name org.eclipse.skalli.core.user.local and start it (enable <ID>).
Users are stored in the directory <workdir>/storage/User. Each user is persisted in a separate XML file named <userId>.xml in this directory.
Example of a <userId>.xml file:
<org.eclipse.skalli.common.User> <userId>ad</userId> <firstname>Arthur</firstname> <lastname>Dent</lastname> <email>arthur.dent@milliways.com</email> <telephone>+000 314159265</telephone> <room>42</room> <location>End of the Universe (and then right)</location> <department>kitchen</department> <company>Milliways - The Restaurant at the End of the Universe</company> <sip>sip:arthur.dent@milliways.com</sip> <detailsMissing>false</detailsMissing> </org.eclipse.skalli.common.User>
Note that userId must be the id of an authenticated user of your web container (Jetty, Tomcat etc.). For example, in Jetty you can define user ids in etc/realm.properties.
Configuring Administrator Users
Skalli administrators are allowed to do more than normal users, eg. they are allowed to:
- edit all projects
- delete projects
- see issues for all projects
- configure a Skalli instance
Skalli adds the command admin to the OSGI console that allows to list, add and remove Skalli administrators:
skalli admin [-list] [-add <admin_id>] [-remove <admin_id>] - maintain set of user with administrative permissions
If you for example want to add the user skalliadmin to the group of administrators type
osgi> skalli admin -add skalliadmin
Administrators are persisted in the directory <workdir>/storage/Group.
Terms
| [Skalli] Extension | All display & application logic elements needed to provide a specific functionality. You can write your own extensions and bring Skalli to visualise their information. |
| Info Box | A single box displaying the information of one extension to the user |
| Project Details Page | The main project page containing the info boxes |
| View Mode | The project details page without edit forms and without initially visible editing capabilities |
| Navigation Panel | The list of links on the left hand side (currently of the project details page) |
| Edit Mode | The forms page when clicking edit in the navigation panel of the project details page |