Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Explain storage/location import options

Browse Source 
* docs: Explain storage/location import options

* docs: Fix language

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>

---------

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
This commit is contained in:
Joachim Van Herwegen 2023-11-17 11:26:54 +01:00 committed by GitHub
parent 15a929a87e
commit 01623e0b5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
config/storage/README.md
View File

@ -22,6 +22,17 @@ Used by certain classes for internal storage.
* *memory*: Store everything in memory. * *memory*: Store everything in memory.
* *resource-store*: Store everything in a specific container in the resource store. * *resource-store*: Store everything in a specific container in the resource store.
## Location
Tells the server where it can find the storage root(s).
Solid does not allow storage roots to be nested,
so usually you either have one storage root at the server with no pods,
or multiple storage roots at pod level with an inaccessible server root.
* *pod*: Indicates that the root storages are at pod level.
If subdomains are used for pods, this will also include the actual server root.
* *root*: There is only one storage root, and it is the same as the server root.
## Middleware ## Middleware
The chain of utility ResourceStores that needs to be passed through before reaching the backend stores. The chain of utility ResourceStores that needs to be passed through before reaching the backend stores.

3
src/http/output/metadata/StorageDescriptionAdvertiser.ts
View File

@ -36,7 +36,8 @@ export class StorageDescriptionAdvertiser extends MetadataWriter {
storageRoot = await this.storageStrategy.getStorageIdentifier(identifier); storageRoot = await this.storageStrategy.getStorageIdentifier(identifier);
this.logger.debug(`Found storage root ${storageRoot.path}`); this.logger.debug(`Found storage root ${storageRoot.path}`);
} catch (error: unknown) { } catch (error: unknown) {
this.logger.error(`Unable to find storage root: ${createErrorMessage(error)}`); this.logger.error(`Unable to find storage root: ${createErrorMessage(error)
}. The storage/location import in the server configuration is probably wrong.`);
return; return;
} }
const storageDescription = joinUrl(storageRoot.path, this.relativePath); const storageDescription = joinUrl(storageRoot.path, this.relativePath);