From efff61c454a7a8154fc0b1e2a290d4934ef37778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Mon, 1 Aug 2022 16:36:29 +0200 Subject: [PATCH] Website: add some documentation about the storage options Basically it's "simple, efficient, isolated -- pick two". --- .../content/usage/shared-storage/_index.md | 38 ++++++++++++++++++- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/web/project-website/content/usage/shared-storage/_index.md b/web/project-website/content/usage/shared-storage/_index.md index 07681985..8421f057 100644 --- a/web/project-website/content/usage/shared-storage/_index.md +++ b/web/project-website/content/usage/shared-storage/_index.md @@ -5,7 +5,29 @@ title: Shared Storage Flamenco needs some form of *shared storage*: a place for files to be stored that can be accessed by all the computers in the farm. -TODO: write more about this. +Basically there are three approaches to this: + +| Approach | Simple | Efficient | Render jobs are isolated | +|-------------------------------------|--------|-----------|--------------------------| +| Work directly on the shared storage | ✅ | ✅ | ❌ | +| Create a copy for each render job | ✅ | ❌ | ✅ | +| Shaman Storage System | ❌ | ✅ | ✅ | + +Each is explained below. + +## Work Directly on the Shared Storage + +Working directly in the shared storage is the simplest way to work with Flamenco. + +## Creating a Copy for Each Render Job + +The "work on shared storage" approach has the downside that render jobs are not +fully separated from each other. For example, when you change a texture while a +render job is running, the subsequently rendered frames will be using that +altered texture. If this is an issue for you, and you cannot use the [Shaman +Storage System][shaman], the approach described in this section is for you. + +[shaman]: #shaman-storage-system ## Shaman Storage System @@ -15,7 +37,19 @@ TODO: write ### Windows -TODO: lots of tricky stuff about getting symlinks to work on Windows. We may want to get inspiration from the [Git-for-Windows](https://github.com/git-for-windows/git/wiki/Symbolic-Links#allowing-non-administrators-to-create-symbolic-links) documentation. +The Shaman storage system uses _symbolic links_. On Windows the creation of +symbolic links requires a change in security policy. Unfortunately, *Home* +editions of Windows do not have a policy editor, but the freely available +[Polsedit][polsedit] can be used on these editions. + +1. Press Win+R, in the popup type `secpol.msc`. Then click OK. +2. In the _Local Security Policy_ window that opens, go to _Security Settings_ > _Local Policies_ > _User Rights Assignment_. +3. In the list, find the _Create Symbolic Links_ item. +4. Double-click the item and add yourself (or the user running Flamenco Manager or the whole users group) to the list. +5. Log out & back in again, or reboot the machine. + +[polsedit]: https://www.southsoftware.com/polsedit.html + ### Linux