Dsadmin

Note: If you‘re reading this file as plaintext, do yourself a favor and execute a rake dsadmin_doc and read everything nicely html-ized in doc/api/.

Installation

FIXME: Installation documentation and an actual partway automated installation process will come later.

Directory Structure

Dsadmin basically uses the "standard" rails directory structure, even though it‘s technically two separate apps (webfe and admind) and admind is not a rails application.

app/:	Source code. Controllers, views and models. The models are shared between webfe and admind, the other parts are webfe-only.
config/:	Configuration files for everything
db/:	Database and LDAP setup scripts, schemas etc
doc/:	Documentation. Generated docs (rake dsadmin_doc) is in doc/api
lib/:	Source code. The main stuff actually.
log/:	Default location for logfiles
public/:	Document root for the web frontend, containing all static pages, images etc
script/:	See files/doc/src/cmdline.html
test/:	All tests and their helpers
tmp/:	Mainly for storing data during tests
vendor/:	Rails and other thirdparty code

Further Reading

See files/doc/src/developer-overview.html

Rakefile Targets

info:	Displays info on prerequisites etc. Recommended! (FIXME: incomplete for now)
dsadmin_doc:	Creates all documentation (in doc/api/)
untittest:	Performs all unit tests on the code. Requires a properly set up test environment.
stats:	Displays lines-of-code statistics

There are also quite some rake tasks set up by rails. Most of them are for development only, some are broken and some don‘t exactly do what you‘d expect. So I recommend not using them. rake —tasks will give you a full list.

Legalese

Authors

 * Christian Reiniger <creinig@dotsrc.org>
     Core system and basically everything else for now

License

 Gnu GPL. See the file LICENSE for details.