Easiest way to run the project is to use Docker. Assuming you have
docker and docker-compose installed, you can run the following
commands.
docker-compose build
docker-compose upThis sets up a database, a local login instance, and a Pls instance.
Then you can access the server at http://localhost:4000.
Without docker you will need a separate postgres database and an up-to-date elixir installation. You will also need a valid API key to login, or run your own instance of nyckeln-under-dörrmattan.
To initialize the database run the mix tasks
mix ecto.create
mix ecto.migrate
# Optional: seed the database with some test data
mix run priv/repo/seeds.exsTo start the server run
mix run --no-haltTo enter an interactive elixir shell and start the server run
iex -S mixFrom there you can use the methods defined in Pls.Queries to edit the database. There are some hard-coded permissions that you need to have in order to make changes to the database.
Most likely you would want to add these as a default, so
that you can later use the frontend to make changes. Replace
<kth-id> with your kth-id.
Pls.Queries.Group.add_permission("pls", "pls")
Pls.Queries.User.add_membership("<kth-id>", "pls", "2050-01-01")POST/DELETE always requires a valid login token as part of the request body. The token needs to be a valid active token from login.
/ <-- Fancy admin frontend
/api/user
/api/user/:uid
/api/user/:uid/:group # Accepts POST/DELETE requests. an expiry date is required when posting
/api/user/:uid/:group/:permission
/api/group
/api/group/:name # Accepts POST/DELETE requests
/api/group/:name/:permission # Accepts POST/DELETE requests
/api/mandate/:name # Name is email as defined by dfunkt.
/api/mandate/:name/:group # Accepts POST/DELETE
/api/token/:token/:system
/api/token/:token/:system/:permission
/api/token/:tag/:group # Accepts POST/DELETE