Set up Q.Wiki Client

Prerequisites

  • You must have Key User or Administrator access to your Q.wiki instance.

  • Your Q.wiki instance needs to be on version 6.3 or above.

1. Create a service account user in Q.wiki

The amberconnector can be invited directly within Q.wiki's own user management.

  1. As a Key User or Administrator log in to your Q.wiki instance

  2. Go to 🛠️ Tools → User Management via the bottom left navigation menu

  3. Click + Invite user. A dialog opens. Fill out the form with the following details:

    • Email address: Use a dedicated email address you have access to. This must not match any email address already stored in the Q.wiki system.

    • As Initial Group it is enough to give the service account Read-only access rights

  4. Click Create invitation. The new user will receive an email with a personal invitation link.

  5. Log in as the new amberconnector user using the invitation link received via Email and complete the registration by setting a name and a secure password.

  6. This service account can now be invited to have read access to the Modules that should be indexed.

2. Generate a Content API Token

The amberconnector user needs a personal Content API token to allow programmatic access to Q.wiki process module content. The API respects user permissions. Only pages accessible to this user will be indexed by Amber.

  1. Log in to Q.wiki as the amberconnector user.

  2. Navigate to User → My Profile → Content API.

  3. Click Add Token.

  4. Give the API Token a name like AmberConnector. Copy and securely store the generated token - it will only be displayed once.

3. Share Credentials

Once the user is created, added to the Modules it should index only, and the API token has been generated, please securely share the following information with the Amber support team:

  1. URL of your Q.wiki instance (e.g., https://<tenant>.qwikinow.de)

  2. Content API Token of the amberconnector service account