Overhaul documentation

Author: Zinidia

docs/backend/README.md

@@ -1,15 +1,15 @@
 # Obstor Backend
-Obstor Backend adds S3 and [other supported protocol](https://obstor.net/docs/protocols) compatibility to third-party cloud storage providers.
+Obstor Backend adds S3 and [other supported protocol](/docs/protocols) compatibility to third-party cloud storage providers.
 
 ## Supported Backends
-- [NAS](nas.md)
-- [Microsoft Azure Blob Storage](azure.md)
-- [HDFS](hdfs.md)
-- [S3](s3.md)
-- [Google Cloud Storage](gcs.md)
-- [SFTP](sftp.md)
+- [NAS](/docs/backend/nas)
+- [Microsoft Azure Blob Storage](/docs/backend/azure)
+- [HDFS](/docs/backend/hdfs)
+- [S3](/docs/backend/s3)
+- [Google Cloud Storage](/docs/backend/gcs)
+- [SFTP](/docs/backend/sftp)
 
 ## Explore Further
-- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
-- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
-- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
+- [Supported Protocols](/docs/protocols) - S3, SFTP, and more
+- `mc` command-line interface
+- `aws` command-line interface

docs/backend/azure.md

@@ -1,17 +1,17 @@
 # Obstor Azure Backend
-Obstor Backend adds S3 and [other supported protocol](https://obstor.net/docs/protocols) compatibility to Microsoft Azure Blob Storage.
+Obstor Backend adds S3 and [other supported protocol](/docs/protocols) compatibility to Microsoft Azure Blob Storage.
 
 ## Run Obstor Backend for Microsoft Azure Blob Storage
 ### Using Docker
-```
+```bash
 docker run -p 9000:9000 --name azure-s3 \
  -e "OBSTOR_ROOT_USER=azurestorageaccountname" \
  -e "OBSTOR_ROOT_PASSWORD=azurestorageaccountkey" \
  ghcr.io/cloudment/obstor backend azure
 ```
 
 ### Using Binary
-```
+```bash
 export OBSTOR_ROOT_USER=azureaccountname
 export OBSTOR_ROOT_PASSWORD=azureaccountkey
 obstor backend azure
@@ -24,16 +24,16 @@ Obstor Backend comes with an embedded web based object browser. Point your web b
 `mc` provides a modern alternative to UNIX commands such as ls, cat, cp, mirror, diff etc. It supports filesystems and S3-compatible cloud storage services.
 
 ### Configure `mc`
-```
+```bash
 mc alias set myazure http://backend-ip:9000 azureaccountname azureaccountkey
 ```
 
 ### List containers on Microsoft Azure
-```
+```bash
 mc ls myazure
-[2017-02-22 01:50:43 PST]     0B ferenginar/
-[2017-02-26 21:43:51 PST]     0B my-container/
-[2017-02-26 22:10:11 PST]     0B test-container1/
+[2026-05-22 01:50:43 PST]     0B ferenginar/
+[2026-05-26 21:43:51 PST]     0B my-container/
+[2026-05-26 22:10:11 PST]     0B test-container1/
 ```
 
 ### Use custom access/secret keys
@@ -53,7 +53,7 @@ Other limitations:
 - Bucket notification APIs are not supported.
 
 ## Explore Further
-- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
-- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
-- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
-- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)
+- [Supported Protocols](/docs/protocols) - S3, SFTP, and more
+- `mc` command-line interface
+- `aws` command-line interface
+- `minio-go` Go SDK

docs/backend/gcs.md

@@ -1,6 +1,6 @@
 # Obstor GCS Backend
 
-Obstor GCS Backend allows you to access Google Cloud Storage (GCS) with S3-compatible APIs and [other supported protocols](https://obstor.net/docs/protocols)
+Obstor GCS Backend allows you to access Google Cloud Storage (GCS) with S3-compatible APIs and [other supported protocols](/docs/protocols)
 
 - [Run Obstor Backend for GCS](#run-obstor-backend-for-gcs)
 - [Test Using Browser Dashboard](#test-using-obstor-browser)
@@ -20,7 +20,7 @@ Obstor GCS Backend allows you to access Google Cloud Storage (GCS) with S3-compa
 **Note:** For alternate ways to set up *Application Default Credentials*, see [Setting Up Authentication for Server to Server Production Applications](https://developers.google.com/identity/protocols/application-default-credentials).
 
 ### 1.2 Run Obstor GCS Backend Using Docker
-```sh
+```bash
 docker run -p 9000:9000 --name gcs-s3 \
  -v /path/to/credentials.json:/credentials.json \
  -e "GOOGLE_APPLICATION_CREDENTIALS=/credentials.json" \
@@ -31,7 +31,7 @@ docker run -p 9000:9000 --name gcs-s3 \
 
 ### 1.3 Run Obstor GCS Backend Using the Obstor Binary
 
-```sh
+```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json
 export OBSTOR_ROOT_USER=obstoraccesskey
 export OBSTOR_ROOT_PASSWORD=obstorsecretkey
@@ -52,24 +52,24 @@ Obstor Client is a command-line tool called `mc` that provides UNIX-like command
 
 Use the following command to configure the backend:
 
-```sh
+```bash
 mc alias set mygcs http://backend-ip:9000 obstoraccesskey obstorsecretkey
 ```
 
 ### 3.2 List Containers on GCS
 
 Use the following command to list the containers on GCS:
 
-```sh
+```bash
 mc ls mygcs
 ```
 
 A response similar to this one should be displayed:
 
 ```
-[2017-02-22 01:50:43 PST]     0B ferenginar/
-[2017-02-26 21:43:51 PST]     0B my-container/
-[2017-02-26 22:10:11 PST]     0B test-container1/
+[2026-05-22 01:50:43 PST]     0B ferenginar/
+[2026-05-26 21:43:51 PST]     0B my-container/
+[2026-05-26 22:10:11 PST]     0B test-container1/
 ```
 
 ### 3.3 Known limitations
@@ -83,7 +83,7 @@ Other limitations:
 * Bucket notification APIs are not supported.
 
 ## <a name="explore-further"></a>4. Explore Further
-- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
-- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
-- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
-- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)
+- [Supported Protocols](/docs/protocols) - S3, SFTP, and more
+- `mc` command-line interface
+- `aws` command-line interface
+- `minio-go` Go SDK

docs/backend/hdfs.md

@@ -1,28 +1,28 @@
 # Obstor HDFS Backend
-Obstor HDFS backend adds S3 API and [other supported protocol](https://obstor.net/docs/protocols) support to Hadoop HDFS filesystem. Applications can use both the S3 and file APIs concurrently without requiring any data migration. Since the backend is stateless and shared-nothing, you may elastically provision as many Obstor instances as needed to distribute the load.
+Obstor HDFS backend adds S3 API and [other supported protocol](/docs/protocols) support to Hadoop HDFS filesystem. Applications can use both the S3 and file APIs concurrently without requiring any data migration. Since the backend is stateless and shared-nothing, you may elastically provision as many Obstor instances as needed to distribute the load.
 
 > NOTE: Intention of this backend implementation it to make it easy to migrate your existing data on HDFS clusters to Obstor clusters using standard tools like `mc` or `aws-cli`, if the goal is to use HDFS perpetually we recommend that HDFS should be used directly for all write operations.
 
 ## Run Obstor Backend for HDFS Storage
 
 ### Using Binary
 Namenode information is obtained by reading `core-site.xml` automatically from your hadoop environment variables *$HADOOP_HOME*
-```
+```bash
 export OBSTOR_ROOT_USER=obstor
 export OBSTOR_ROOT_PASSWORD=obstor123
 obstor backend hdfs
 ```
 
 You can also override the namenode endpoint as shown below.
-```
+```bash
 export OBSTOR_ROOT_USER=obstor
 export OBSTOR_ROOT_PASSWORD=obstor123
 obstor backend hdfs hdfs://namenode:8200
 ```
 
 ### Using Docker
 Using docker is experimental, most Hadoop environments are not dockerized and may require additional steps in getting this to work properly. You are better off just using the binary in this situation.
-```
+```bash
 docker run -p 9000:9000 \
  --name hdfs-s3 \
  -e "OBSTOR_ROOT_USER=obstor" \
@@ -44,13 +44,13 @@ To enable kerberos authentication, you need to set `hadoop.security.authenticati
 ```
 
 Obstor will load `krb5.conf` from environment variable `KRB5_CONFIG` or default location `/etc/krb5.conf`.
-```sh
+```bash
 export KRB5_CONFIG=/path/to/krb5.conf
 ```
 
 If you want Obstor to use ccache for authentication, set environment variable `KRB5CCNAME` to the credential cache file path,
 or Obstor will use the default location `/tmp/krb5cc_%{uid}`.
-```sh
+```bash
 export KRB5CCNAME=/path/to/krb5cc
 ```
 
@@ -62,7 +62,7 @@ If you prefer to use keytab, with automatically renewal, you need to config thre
 
 Please note that the username is not principal name.
 
-```sh
+```bash
 export KRB5KEYTAB=/path/to/keytab
 export KRB5USERNAME=hdfs
 export KRB5REALM=REALM.COM
@@ -79,17 +79,17 @@ export KRB5REALM=REALM.COM
 
 ### Configure `mc`
 
-```
+```bash
 mc alias set myhdfs http://backend-ip:9000 access_key secret_key
 ```
 
 ### List buckets on hdfs
 
-```
+```bash
 mc ls myhdfs
-[2017-02-22 01:50:43 PST]     0B user/
-[2017-02-26 21:43:51 PST]     0B datasets/
-[2017-02-26 22:10:11 PST]     0B assets/
+[2026-05-22 01:50:43 PST]     0B user/
+[2026-05-26 21:43:51 PST]     0B datasets/
+[2026-05-26 22:10:11 PST]     0B assets/
 ```
 
 ### Known limitations
@@ -101,7 +101,7 @@ Backend inherits the following limitations of HDFS storage layer:
 - Concurrent multipart operations are not supported (HDFS lacks safe locking support, or poorly implemented)
 
 ## Explore Further
-- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
-- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
-- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
-- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)
+- [Supported Protocols](/docs/protocols) - S3, SFTP, and more
+- `mc` command-line interface
+- `aws` command-line interface
+- `minio-go` Go SDK

docs/backend/nas.md

@@ -1,14 +1,14 @@
 # Obstor NAS Backend
 
-Obstor Backend adds S3 and [other supported protocol](https://obstor.net/docs/protocols) compatibility to NAS storage. You may run multiple obstor instances on the same shared NAS volume as a distributed object backend.
+Obstor Backend adds S3 and [other supported protocol](/docs/protocols) compatibility to NAS storage. You may run multiple obstor instances on the same shared NAS volume as a distributed object backend.
 
 ## Run Obstor Backend for NAS Storage
 
 ### Using Docker
 
 Please ensure to replace `/shared/nasvol` with actual mount path.
 
-```
+```bash
 docker run -p 9000:9000 --name nas-s3 \
  -e "OBSTOR_ROOT_USER=obstor" \
  -e "OBSTOR_ROOT_PASSWORD=obstor123" \
@@ -18,7 +18,7 @@ docker run -p 9000:9000 --name nas-s3 \
 
 ### Using Binary
 
-```
+```bash
 export OBSTOR_ROOT_USER=obstor
 export OBSTOR_ROOT_PASSWORD=obstor123
 obstor backend nas /shared/nasvol
@@ -36,17 +36,17 @@ Obstor Backend comes with an embedded web based object browser. Point your web b
 
 ### Configure `mc`
 
-```
+```bash
 mc alias set mynas http://backend-ip:9000 access_key secret_key
 ```
 
 ### List buckets on nas
 
-```
+```bash
 mc ls mynas
-[2017-02-22 01:50:43 PST]     0B ferenginar/
-[2017-02-26 21:43:51 PST]     0B my-bucket/
-[2017-02-26 22:10:11 PST]     0B test-bucket1/
+[2026-05-22 01:50:43 PST]     0B ferenginar/
+[2026-05-26 21:43:51 PST]     0B my-bucket/
+[2026-05-26 22:10:11 PST]     0B test-bucket1/
 ```
 
 ### The file-based config settings are deprecated in NAS
@@ -67,7 +67,7 @@ notify_webhook:1 endpoint=http://localhost:8080/ auth_token= queue_limit=0 queue
 
 The corresponding environment variable setting can be
 
-```
+```bash
 export OBSTOR_NOTIFY_WEBHOOK_ENABLE_1=on
 export OBSTOR_NOTIFY_WEBHOOK_ENDPOINT_1=http://localhost:8080/
 export OBSTOR_NOTIFY_WEBHOOK_QUEUE_DIR_1=/tmp/webhk
@@ -93,7 +93,7 @@ NAS backend implementation allows symlinks on regular files,
 *Directory symlinks is not and will not be supported as there are no safe ways to handle them.*
 
 ## Explore Further
-- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
-- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
-- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
-- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)
+- [Supported Protocols](/docs/protocols) - S3, SFTP, and more
+- `mc` command-line interface
+- `aws` command-line interface
+- `minio-go` Go SDK