Skip to content

Latest commit

 

History

History
82 lines (62 loc) · 3.58 KB

README.md

File metadata and controls

82 lines (62 loc) · 3.58 KB
Raw

How to run the Ceylon Herd Module Repository

Note: at the moment Herd requires Play 1.2 which does not work on Java 8, so proceed with Java 7. We are going to move it to Play 1.3 as soon as possible to fix that.

  1. Download Play Framework 1.2.7 and install it
  2. Clone the Herd repository
  3. Open a shell and go to the ceylon-herd directory you just cloned
  4. Run play dependencies to download the required modules
  5. Create your Postgres DB
    1. sudo su - postgres
    2. createuser -PSRD ceylon-herd
    3. enter ceylon-herd as password when prompted
    4. createdb -O ceylon-herd -E utf8 ceylon-herd
    5. exit
  6. Run the application
    1. play run

How to make your user (if registration is disabled, which is the default for now)

This can only be done by hand for now:

  1. Pick a (dummy temporary) password
  2. Hash it with BCrypt (for example, online at http://bcrypthashgenerator.apphb.com or other locations)
    1. Copy the resulting BCrypt Hash
    2. Don't worry about giving your password online, just pick a dummy temporary password and you can change it later in Herd.
  3. Open a psql console to your database:
    1. psql -h localhost -U ceylon-herd
  4. Add your user (as admin)
    1. INSERT INTO user_table (id, email, firstname, admin, lastname, isbcrypt, password, status, username) VALUES ((select nextval('hibernate_sequence')), 'email@example.org', 'FirstName', true, 'LastName', true, 'YOUR_BCRYPT_HASH', 'REGISTERED', 'UserName');
  5. You can now log in and change your password using the UI

How to make your user admin (if registration is enabled)

This can only be done by hand for now:

  1. Register your user at http://localhost:9000/register
  2. See in the logs in the console what your activation link is, and follow it (in DEV mode no mail is sent)
  3. Complete your registration
  4. Open a psql console to your database:
    1. psql -h localhost -U ceylon-herd
  5. Set yourself as admin
    1. UPDATE user_table SET admin = true WHERE username = 'your-user-name';

Troubleshooting

  1. If you get the error FATAL: Ident authentication failed for user "ceylon-herd" look here for a possible solution

Setting up Herd in Eclipse

  1. Create a new Java Project using existing sources of ceylon-herd
  2. Create a User Library for Play 1.2
    1. Add the framework/play.jar
    2. Add every framework/lib/*.jar
  3. Add the Play 1.2 User Library to the ceylon-herd project build path

License

The content of this repository is released under AGPLv3 as provided in the LICENSE file that accompanied this code, with the following clarifications.

The AGPL does not extend to the files in the public/ directory. Such files are licensed as indicated in the file or else are dedicated to the public domain to the maximum extent possible under applicable law.

The AGPL does not extend to any dependencies that we do not distribute in our github repository or which are indicated in our github repository as being under some other license, even if AGPL-compatible. For example, if you create and publicly deploy a modified version of Ceylon Herd that is based on the Play framework, the AGPL does not extend to any of the dependencies that make up the Play framework.

Compliance with the source code requirements of section 13 of AGPLv3 is satisfied by storing your modified version in a public revision control repository and prominently providing your users with notice of the location of this repository.