Not clear how to manage members

[Franchovy]

Hi all,

First off, thank you for your work. This is invaluable considering the self-hosted version doesn't have any ACL by default. I've managed to get the setup up and running and successfully used the "maps" portion of the admin interface.

However, I wanted to know more about the "users" side of things. I've been able to create users, attach tags on them, etc., however I don't see a way to actually log those users in. That's strange to me given that the entire point of the ACL is for controlled access (at least by "members" who can be granted special permissions, such as editing rights, megaphone, etc.).

Could you please clarify what is the right course of action for adding/editing/logging in as a member? The "/register" endpoint is not found, and by default self-hosted WA does not even provide a log in/log out feature.

Thank you very much in advance. Please let me know if there's an opportunity to contribute on this project as well.

[Franchovy]

So, gonna document here as I learn more about this.

Workadventure actually supports an Admin API in the self-hosted version, you just need to configure in the .env to have it connect, and the "play" and "back" containers automatically handle fetching multiple things: maps, rooms, wokas (player textures). Documentation page is here: https://github.com/workadventure/workadventure/blob/master/docs/others/self-hosting/adminAPI.md

This is very nice, however I'm not seeing users included in this list. I believe users might not be included anymore, and you need to use an OpenID provider to have users/members/etc... but perhaps then the admin API is useful for giving certain rights?

I will update further as I continue with the setup.

[ttefke]

Hello @Franchovy

Thank you for showing interest in this project.
You need to set up a user in the web interface of this admin API first before you are able to use the register endpoint. When creating the user, you will get a magic link using the register endpoint, added with a unique token. This link should work.
Can you please let me know which version of WorkAdventure you use? Then I can check if there are any issues. In some versions this endpoint is a bit buggy and requires a patch.
If you are interested in contributing, feel free to submit a PR.

Best regards,
Tobias

[Franchovy]

Hi @ttefke, apologies for the late reply.

I've spent the last week or so configuring OIDC authentication and now have a locally-hosted provider working. However, I see that the admin API does not use this provider natively. Therefore any logins/signups using the OIDC provider are separate from the ones created via the admin dashboard.

Unfortunately I run into errors when I enable the admin API via the .env file, workadventure fails to start properly due to a map fetch error:

Room.ts:228 Error => getMapDetail ApiError: The API returned an error
    at dj.getMapDetail (Room.ts:213:23)
    at async dj.createRoom (Room.ts:92:28)
    at async frg.initGameConnexion (ConnectionManager.ts:322:33)
    at async Alg.init (GameManager.ts:59:24)
getMapDetail @ Room.ts:228
await in getMapDetail
createRoom @ Room.ts:92
initGameConnexion @ ConnectionManager.ts:322
init @ GameManager.ts:59
(anonymous) @ EntryScene.ts:42
Promise.then
loadLocale @ EntryScene.ts:40
create @ EntryScene.ts:31
create @ phaser.js:197569
loadComplete @ phaser.js:197476
n.emit @ phaser.js:200
loadComplete @ phaser.js:119639
fileProcessComplete @ phaser.js:119605
onProcessComplete @ phaser.js:118211
data.onload @ phaser.js:124728
ErrorScreenStore.ts:98 ApiError: The API returned an error
    at dj.getMapDetail (Room.ts:213:23)
    at async dj.createRoom (Room.ts:92:28)
    at async frg.initGameConnexion (ConnectionManager.ts:322:33)
    at async Alg.init (GameManager.ts:59:24)

Therefore I'm not really able to test any of the members functionality from within workadventure, I only have the dashboard which works independently of the app itself.

[ttefke]

Hello @Franchovy ,
Please excuse the late response. Currently, OIDC is not supported. The only way to register members is by using the magic links shown on the user's pages in the admin panel.
For the maps please note the following: all maps need to be hosted on a server and they also must have valid entries in the map-storage service. Hence, please ensure

1. The maps are hosted on a (publicly) available web server
2. Bindings to these maps exist in the map-storage service
3. The maps are registered in the admin service
4. A valid start map is configured in the WorkAdventure env file.

Best regards,
Tobias