hackage-server

This is the hackage-server code. This is what powers http://hackage.haskell.org, and many other private hackage instances.

Mac OS X users note

You'll need to do the following to get hackage-server to build:

brew install icu4c
brew link icu4c --force

Running

cabal install -j --enable-tests

hackage-server init
hackage-server run

By default the server runs on port 8080 with the following settings:

URL:      http://localhost:8080/
username: admin
password: admin

To specify something different, see hackage-server init --help for details.

The server can be stopped by using Control-C.

This will save the current state and shutdown cleanly. Running again will resume with the same state.

Resetting

To reset everything, kill the server and delete the server state:

rm -rf state/

Note that the datafiles/ and state/ directories differ: datafiles is for static html, templates and other files. The state directory holds the database (using acid-state and a separate blob store).

Creating users & uploading packages

Admin front-end: http://localhost:8080/admin
List of users: http://localhost:8080/users/
Register new users: http://localhost:8080/users/register

Currently there is no restriction on registering, but only an admin user can grant privileges to registered users e.g. by adding them to other groups. In particular there are groups:

admins http://localhost:8080/users/admins/ -- administrators can do things with user accounts like disabling, deleting, changing other groups etc.
trustees http://localhost:8080/packages/trustees/ -- trustees can do janitorial work on all packages
mirrors http://localhost:8080/packages/mirrorers/ -- for special mirroring clients that are trusted to upload packages
per-package maintainer groups http://localhost:8080/package/foo/maintainers -- users allowed to upload packages
uploaders http://localhost:8080/packages/uploaders/ -- for uploading new packages

Mirroring

There is a client program included in the hackage-server package called hackage-mirror. It's intended to run against two servers, syncing all the packages from one to the other, e.g. getting all the packages from the old hackage and uploading them to a local instance of a hackage-server.

To try it out:

On the target server, add a user to the mirrorers group via http://localhost:8080/packages/mirrorers/
Create a config file that contains the source and target servers. Assuming you are cloning the packages on http://hackage.haskell.org locally, you could create a config file as follows:

echo -e "http://hackage.haskell.org\nhttp://admin:admin@localhost:8080/" > servers.cfg

Run the client, pointing to the config file:

hackage-mirror servers.cfg