RestAuth: Unterschied zwischen den Versionen

Aus Free Software
Zur Navigation springen Zur Suche springen
(Weiterleitung auf Https://restauth.net erstellt)
 
(21 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
RestAuth attempts to provide a shared authentication service loosely based on the [http://en.wikipedia.org/wiki/Representational_State_Transfer REST paradigm]. Therefore simple HTTP requests can be used to perform the basic [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete CRUD operations] on the users known to RestAuth. The prime design goal is to be easy to integrate into services that want to use it, we develop plugins for Apache and MediaWiki ourself (with some more coming soon).
+
#REDIRECT [[https://restauth.net]]
 
 
=== Installation and configuration ===
 
RestAuth itself is written in [http://www.python.org Python] and is based on [http://www.djangoproject.com/ Django]. You therefore need python-2.4 or later (python-3 is currently unsupported by Django) and Django 1.2. Please see the [http://docs.djangoproject.com/en/1.2/topics/install/ installation instructions] on how to install Django.
 
 
 
RestAuth can (so far) only be downloaded directly from SVN. To download RestAuth, simply do:
 
<nowiki>svn co http://svn.fsinf.at/fs/RestAuth/RestAuth</nowiki>
 
RestAuth, like any other Django project, can be configured  in the file <tt>settings.py</tt>. Since this is the file comes directly from SVN, it is advised that copy <tt>localsettings.py.example</tt> to <tt>localsettings.py</tt> and use this file to configure it. The file is documented well, so just skim through the file. 
 
 
 
===== Legal usernames =====
 
By default, RestAuth only allows ASCII letters, numbers, and a very limited number of special characters in usernames. This is because usernames must be valid in all systems that use RestAuth. But you can easily extend the range of allowed characters (even to usernames using Unicode characters!) if you know that you will never use some of the supported systems. For further information please read our documentation on [[/Usernames|usernames]].
 
 
 
Note that RestAuth treats all usernames as case insensitive. Therefor, the users "Mati", "MATI", "mAti" and "mati" all are considered the same.
 
 
 
===== Add services =====
 
Since you will never want RestAuth to be available to the outside, services that want to use RestAuth also ''must'' authenticate against it. We provide a script to easily manage the credentials of services from the command line. The script is also available from SVN:
 
<nowiki>svn co http://svn.fsinf.at/fs/RestAuth/bin</nowiki>
 
 
 
Try the restauth-service script to add services to the database - and don't forget to add valid hosts. See <tt>restauth-service.py --help</tt> and <tt>restauth-service.py add --help</tt> for usage information.
 
 
 
=== Service integration ===
 
Todo:
 
* MediaWiki plugin
 
* Apache plugin
 
 
 
=== Write new software using RestAuth ===
 
The prime goal of RestAuth is to make it as easy as possible to develop/modify/extend existing software to authenticate against RestAuth. As with any REST service, we provide CRUD operations for defined entities. But we deviate from that paradigm in several places to meet our primary design goal.
 
 
 
For a detailed interface specification, please see:
 
* [[/General response codes|General response codes]] - a list of response codes that could always be thrown
 
* [[/Managing users|Managing users]] - The interface to manage users
 
* [[/Managing groups|Managing groups]] - The interface to manage groups
 

Aktuelle Version vom 10. September 2011, 18:28 Uhr

Weiterleitung nach: