How to share access to your Assets Library

Introduction

In The Forge, you can share your Assets Library with your friends, or access it from your local Foundry VTT installation.

To do so securely, we created the API Key Manager. With it, you can generate any number of API keys with different permissions (read only, or read and write), and even set how long you want them to be valid for (for instance, if you only want to give your players an hour of access to your library for uploading art).

You can also revoke your keys at any time, if concerned about the security of your assets library, or if the key is publicly leaked.

We have a quick video detailing how the featured can be used, in a step by step process:

How to Use the API Key Manager

Generating a new API Key

First, navigate to your account page, and enter the API Key Manager tab, located here.

Once you open the API Manager, you will be greeted with this screen:

Read through the text on the page to make sure that you understand how it works, and then configure the options for the new key (what it can do, and whether it expires).

In this example, we set the API key to have read and write permissions, for 24 hours.

Once you are done, click the “Generate API Key” button and the key will be displayed :

From here the key can be sent to other players/users, or copied into your local Foundry VTT installation. Do not share or screenshot your key publicly- the key shown above has already been revoked.

Revoking access to API Keys

To revoke your API keys, click the “Reset All Keys” button in the API Key manager:

Note: When you do so, every key previously generated from your account becomes invalid. Since our internal system uses the same APIs to grant you access to your assets within a Foundry game, you may be unable to access your assets library from within Foundry VTT immediately after revoking your keys. Reloading your Foundry VTT game will fix this.

How to use an API Key in Foundry VTT

If you are using Foundry VTT within The Forge website itself, then The Forge module will automatically be loaded. If you are not on The Forge, install The Forge module and enable it in your world.

You can then be go to Configure Settings;
image
and then the “Module Settings” tab;
image
and enter the API Key.

If you are on The Forge’s website, clearing this field will automatically make it use your own Assets Library (assuming you are logged in to The Forge).

Once you are done editing this field, save your settings, and you are good to go!

Note that this setting in Foundry VTT is only saved in the local browser. If you use a different browser, or incognito window, the API Key will need to be entered again.

1 Like