Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

Commit

Permalink
feat: Add details about Storage.
Browse files Browse the repository at this point in the history
  • Loading branch information
NishaSharma14 committed Sep 8, 2022
1 parent 0006bc7 commit 050e132
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 22 deletions.
31 changes: 31 additions & 0 deletions docs/developer-guides/configurations/storage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
sidebar_position: 3
id: storage
title: Storage
---

Files in [nmrxiv](https://nmrxiv.org) are stored as [objects](https://en.wikipedia.org/wiki/Object_storage) and are [S3](https://en.wikipedia.org/wiki/Amazon_S3) compatible which provides below three big benefits.
* **Backup/redundancy** - S3 and similar have built-in backups and redundancy
* **Scaling** - Savings files off-server becomes necessary in modern hosting, such as serverless or containerized environments, as well as in traditional load-balanced environments
* **Disk usage** - You won't need as much disk space when storing files in the cloud
* **Features** - S3 (and other clouds) have some great features, such as versioning support for files, lifecycle rules for deleting old files (or storing them in a cheaper way), deletion protection, and more

#### Configuration
There are just two place where the configuration needs to be done.
* Within your Object Storage or Amazon S3 you need to.
* Create the bucket.
* Create a service account to get Key/Secret Key.

* Within the [nmrxiv](https://nmrxiv.org) you just need to configure below values in the `.env` file.
````
FILESYSTEM_DRIVER=
AWS_ACCESS_KEY_ID=xxxxxx
AWS_SECRET_ACCESS_KEY=xxxxxxs
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=nmrxiv
AWS_BUCKET_PUBLIC=nmrxiv-public
AWS_ENDPOINT=<end-point-of-your-storage-provider>
AWS_URL=<end-point-of-your-storage-provider>
````
4 changes: 0 additions & 4 deletions docs/developer-guides/configurations/storage/_category_.json

This file was deleted.

9 changes: 0 additions & 9 deletions docs/developer-guides/configurations/storage/ceph.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/developer-guides/configurations/storage/minio.md

This file was deleted.

0 comments on commit 050e132

Please sign in to comment.