Question: Where is the documentation for generating tokens ?

[christinetasson]

Related user(s):

No response

Related issue(s) or PR(s):

No response

Related project scope(s):

No response

Question?

We are installing an instance of learnocaml for teaching and we couldn't find where is the documentation for generating tokens:

• for teachers
• for students

Thanks !

What has already been tested:

I have read the tutorials in https://github.com/ocaml-sf/learn-ocaml/tree/master/docs

learn-ocaml --version

No response

git describe --long --always --abbrev=40 --tags

No response

What OS do you use?

GNU/Linux

What browser(s) do you use with learn-ocaml?

No response

Additional context:

No response

[erikmd]

Hi @christinetasson,

Sorry for the late reply.
This is a good question, that would deserve more documentation in https://ocaml-sf.org/learn-ocaml/,
so we won't close this issue before it is officially documented.

We are installing an instance of learnocaml for teaching

BTW if you need guidance to deploy the instance with HTTPS using Docker, you may be interested in the comments of issue:

• Question: How to deploy two instances of learn-ocaml #623

and we couldn't find where is the documentation for generating tokens:
for teachers

At the first run of learn-ocaml build serve --repo=path/to/your-exercises-repository, you have sth like this in the log:

• Initial teacher token created: X-DGE-41J-EPO-ZWH
• this is a teacher token (because it starts with X- !)
• you can open the webapp, login with this teacher token,
• go to the Teach dashboard (https://URL/#activity=teacher)
• click on Actions > Create new teacher token:

• Warning: the teacher tokens are powerful as they allow browsing the code of all students, from this Teach dashboard.

for students

the standard way is to setup a secret code in: your-exercises-repository/server_config.json of this form:

{
    "secret": "your-secret-code"
}

then students can create their own account during the first lab session:

• open the webapp
• click on New user? Create a new token
• fill the secret code, and their nickname ideally phrased like PrenomNOM@GroupeTP
• then they get a student token (of the form AAA-BBB-CCC-DDD), which serves as both a user ID and a password

Hope this helps