Commit 1a6c7e3c authored by Andrew's avatar Andrew Committed by acclayto

Add update notes for 0.4.2 release

parent cffc04a4
......@@ -26,6 +26,7 @@ roleplaying games in a beautiful and intuitive web-based application.
pages/entities
pages/dice
pages/features/av
pages/features/aws
pages/api
pages/systems
pages/modules
......
This diff is collapsed.
......@@ -36,3 +36,4 @@ This page contains an archive of published update notes dating back to late stag
notes-0.3.9
notes-0.4.0
notes-0.4.1
notes-0.4.2
.. _s3:
AWS S3 Integration
******************
Foundry Virtual Tabletop features integrated support for AWS S3 file storage which lets you use an AWS account and S3 buckets as a built-in browseable and uploadable storage location for media assets that are used within Foundry VTT. To enable this functionality, you must include an entry in your ``options.json`` config file which points towards another JSON file that contains your AWS credentials. If such a file is correctly specified and the AWS user has permission to access S3 buckets, those buckets will be available for use in the File Browser for players who are allowed to use it.
----------
How To Enable S3 Support
========================
Add an entry in the ``Config/options.json`` config file which exists in your user data location to include key "awsConfig" which provides a relative or absolute file path pointing to another JSON file contraining the following:
.. code-block::
{
"accessKeyId": "YOUR_ACCESS_KEY_ID",
"secretAccessKey": "YOUR_SECRET_ACCESS_KEY",
"region": "YOUR_PREFERRED_REGION"
}
----------
How To Restrict Bucket Permissions
==================================
You may not wish to allow your AWS account to access all S3 buckets from within Foundry VTT. To avoid this, you should create a specific IAM user whose access credentials are used by Foundry Virtual Tabletop. You can assign am IAM policy to this specific user which only permits access to certain buckets within your overall account. An example IAM policy which allows access to only the bucket named ``vtt-assets`` is shown below:
.. code-block::
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::vtt-assets"
]
},
{
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject"
],
"Resource": [
"arn:aws:s3:::vtt-assets/*"
]
}
]
}
For more information, see the following AWS support page: https://aws.amazon.com/premiumsupport/knowledge-center/s3-console-access-certain-bucket/
......@@ -225,8 +225,8 @@ sslCert
automatically.
awsConfig
An absolute or relative path which points to an optional AWS configuration file in JSON format containing
``accessKeyId``, ``secretAccessKey``, ``region``, and ``bucketName`` properties. This file is used to configure
integrated AWS connectivity for S3 assets and backup.
``accessKeyId``, ``secretAccessKey``, and ``region`` properties. This file is used to configure integrated AWS
connectivity for S3 assets and backup.
Where Do I Put My Data?
=======================
......@@ -249,7 +249,7 @@ Windows
MacOS
``~/Library/Application Support/FoundryVTT``
Linux
``~/.local/share/FoundryVTT``
``/home/$USER/.local/share/FoundryVTT``, ``/home/$USER/FoundryVTT``, or ``/local/FoundryVTT`` in order of availability.
These default locations may not be ideal for many users, so it is recommended to use one of the above alternative
methods to point Foundry VTT to a different data location as suits your preferences. The user data folder contains
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment