Changes between Initial Version and Version 1 of ITUserManual

Timestamp:

Mar 20, 2017, 12:09:06 AM (8 years ago)

Author:

landauf

Comment:

—

ITUserManual

@@ +1 @@
+= IT User Manual =
+
+== Account Management ==
+
+Only forum and mailinglists are open for public registration. For every other service you need an orxonox.net account. If you're a PPS student, ask a teaching assistant. If you're an external user and want to contribute to Orxonox, contact us.
+
+=== Access to services ===
+
+With your orxonox.net account, you can use the same login credentials for the following services:
+
+ * Trac (wiki and tickets)
+ * SVN (only required for write-access)
+ * Mail (SMTP-relay and IMAP if you have a mailbox)
+ * Jenkins (manage build jobs)
+
+It does not work for these services:
+
+ * Forum
+ * Mailman (mailing lists)
+ 
+These services are open for public registration, so you can create your own account if you want to use them.
+
+A short note for admins:
+
+ * Zabbix: works with the regular orxonox.net account
+ * Mailman admin: basic authentication works with the regular orxonox.net account, but the mailinglists have individual passwords
+ * SSH: requries separate ssh key and separate sudoer password
+ * LDAP: uses separate credentials
+
+=== Permissions ===
+
+There are four different user groups:
+
+||= Group =||= Members =||= Permissions =||
+|| guest || Everyone that is not logged in || Read access to most resources ||
+|| contributor || PPS students and external users || Write access to most resources ||
+|| moderator || PPS teaching assistants and external moderators || Can delete most resources ||
+|| admin || Server administrators || Full access ||
+
+=== Password recovery ===
+
+Please see the description of the SSP tool -> TODO.
+
+== Services ==
+
+An overview of all services on the Orxonox server that are available to regular users (guests and contributors).
+
+=== Trac (Wiki and Tickets) ===
+
+Trac is the website that you're looking at right now. It contains a wiki, a ticketing system, and a repository browser.
+
+TODO
+
+=== SVN ===
+
+SVN is our central source repository. There are two ways to access SVN:
+
+ * Write access: https://svn.orxonox.net/ (requires an orxonox.net account)
+ * Read only access: http://svn.orxonox.net/
+
+If you're a PPS student, please use write access, otherwise you can't commit your changes to SVN.
+
+=== Mail ===
+
+As a regular user, you receive a <user>@orxonox.net mail alias that forwards to your private address. If you're a PPS student, this is usually your <user>@ee.ethz.ch address.
+
+You may receive emails from Trac or Jenkins on this address on certain occasions.
+
+=== Mailman (Mailing Lists) ===
+
+TODO
+
+=== Jenkins (Buildserver) ===
+
+TODO
+
+=== Forum ===
+
+The forum is open for public registration. If you already have an orxonox.net account, you still need to register in the forum. For that, you can use a different username and password if you like.
+
+=== IRC ===
+
+TODO
+
+=== SSP (Password recovery) ===
+
+If you forget your password, you can recover your account with the self service password tool. If you have a regular orxonox.net account, it is linked with your personal email address. The SSP tool will send a token to this address to recover your account.
+
+In case you have an orxonox.net account with a mailbox and NO forwarding to an external address, you can't recover your account by yourself. In this case you have to contact an administrator to reset your password.