From 55f69745c2a7f7da2127200d4c74f6728325916a Mon Sep 17 00:00:00 2001 From: BookWyrm Bot Date: Tue, 9 Jan 2024 03:07:44 +0000 Subject: [PATCH] build site --- locale/en_US/LC_MESSAGES/messages.po | 2 +- site/external-storage.html | 20 +++++++++++++++++--- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/locale/en_US/LC_MESSAGES/messages.po b/locale/en_US/LC_MESSAGES/messages.po index 70fdfdc4..854ae426 100644 --- a/locale/en_US/LC_MESSAGES/messages.po +++ b/locale/en_US/LC_MESSAGES/messages.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-01-02 19:14+0000\n" +"POT-Creation-Date: 2024-01-09 03:07+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" diff --git a/site/external-storage.html b/site/external-storage.html index 9d55be37..02f1f187 100644 --- a/site/external-storage.html +++ b/site/external-storage.html @@ -224,12 +224,18 @@

BookWyrm Settings

  • AWS_ACCESS_KEY_ID: your access key ID
  • AWS_SECRET_ACCESS_KEY: your secret access key
  • AWS_STORAGE_BUCKET_NAME: your bucket name
    • -
  • AWS_S3_REGION_NAME: e.g. "eu-west-1" for AWS, "fr-par" for Scaleway or "nyc3" for Digital Ocean
    • +
  • AWS_S3_REGION_NAME: e.g. "eu-west-1" for AWS, "fr-par" for Scaleway, "nyc3" for Digital Ocean or "cluster-id" for Linode

    • If your S3-compatible service is Amazon AWS, you should be set. If not, you’ll have to uncomment the following lines:

      -
    • AWS_S3_CUSTOM_DOMAIN: the domain that will serve the assets, e.g. "example-bucket-name.s3.fr-par.scw.cloud" or "${AWS_STORAGE_BUCKET_NAME}.${AWS_S3_REGION_NAME}.digitaloceanspaces.com"
      • -
    • AWS_S3_ENDPOINT_URL: the S3 API endpoint, e.g. "https://s3.fr-par.scw.cloud" or "https://${AWS_S3_REGION_NAME}.digitaloceanspaces.com"
      • +
    • AWS_S3_CUSTOM_DOMAIN: the domain that will serve the assets:
      • +
    • for Scaleway, e.g. "example-bucket-name.s3.fr-par.scw.cloud"
      • +
    • for Digital Ocean, e.g. "${AWS_STORAGE_BUCKET_NAME}.${AWS_S3_REGION_NAME}.digitaloceanspaces.com"
      • +
    • for Linode Object Storage, this should be set to the cluster domain, e.g. "eu-central-1.linodeobjects.com"
      • +
    • AWS_S3_ENDPOINT_URL: the S3 API endpoint:
      • +
    • for Scaleway, e.g. "https://s3.fr-par.scw.cloud"
      • +
    • for Digital Ocean, e.g. "https://${AWS_S3_REGION_NAME}.digitaloceanspaces.com"
      • +
    • For Linode Object Storage, set this to the cluster domain, e.g. "https://eu-central-1.linodeobjects.com"

    Copying local media to external storage

    If your BookWyrm instance is already running and media have been uploaded (user avatars, book covers…), you will need to migrate uploaded media to your bucket.

    @@ -276,6 +282,14 @@

    CORS settings

    No output means it should be good.

    +

    Additional Step for Linode Object Storage Users

    +

    For Linode, you now need to make an alteration to the .env to ensure that the generated links to your storage objects are correct. If you miss this step, all the links to images and static files (like css) will be broken. +To fix this, you need to now insert the bucket-name into the AWS_S3_CUSTOM_DOMAIN, for example if your AWS_STORAGE_BUCKET_NAME is "my-bookwyrm-bucket", then set it to:

    +
    AWS_S3_CUSTOM_DOMAIN=my-bookwyrm-bucket.cluster-id.linodeobjects.com
+
    + +

    Note: From this point on, any bw-dev copy or sync commands will place objects into an incorrect location in your object store, so if you need to use them, revert to the previous setting, run and re-enable.

    +

    New Instance

    If you are starting a new BookWyrm instance, you can go back to the setup instructions right now. If not, keep on reading.

    Restarting your instance

    Once the media migration has been done and the static assets are collected, you can load the new .env configuration and restart your instance with: