mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-17 20:01:44 +02:00
Code Issues Releases Wiki Activity

Updated Setting Up Storage (markdown)

Nick Sweeting
2024-05-10 14:11:24 -07:00
parent e5556edc52
commit dbfd545e99
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Setting-Up-Storage.md

@@ -35,11 +35,15 @@ services:
<img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/45abfe78-87c4-4c87-ab11-9dae2f3b2518" alt="local filesystem icon" width="80px" align="right"/> <img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/45abfe78-87c4-4c87-ab11-9dae2f3b2518" alt="local filesystem icon" width="80px" align="right"/>
<a name="ext4"></a><a name="apfs"></a>
### `EXT4` (default on Linux), `APFS` (default on macOS) ### `EXT4` (default on Linux), `APFS` (default on macOS)
> [!TIP] > [!TIP]
> These default filesystems are fully supported by ArchiveBox on Linux and macOS (w/wo Docker). > These default filesystems are fully supported by ArchiveBox on Linux and macOS (w/wo Docker).
<a name="zfs"></a>
### `ZFS` (recommended for best experience on Linux/BSD) ⭐️ ### `ZFS` (recommended for best experience on Linux/BSD) ⭐️
> [!TIP] > [!TIP]
@@ -80,11 +84,15 @@ zfs create \
-o keysource=passphrase,prompt \ -o keysource=passphrase,prompt \
``` ```
<a name="ntfs"></a><a name="hfs"></a><a name="btrfs"></a>
### `NTFS`, `HFS+`, `BTRFS` ### `NTFS`, `HFS+`, `BTRFS`
> [!WARNING] > [!WARNING]
> These filesystems are likely supported, but are not officially tested. > These filesystems are likely supported, but are not officially tested.
<a name="ext2"></a><a name="ext3"></a><a name="fat32"></a><a name="exfat"></a>
### `EXT2`, `EXT3`, `FAT32`, `exFAT` ### `EXT2`, `EXT3`, `FAT32`, `exFAT`
> [!CAUTION] > [!CAUTION]
@@ -95,6 +103,7 @@ zfs create \
--- ---
<br/> <br/>
<a name="remote-filesystems"></a>
## Supported Remote Filesystems ## Supported Remote Filesystems
@@ -111,6 +120,8 @@ The `data/archive/` subfolder contains the bulk archived content, and it support
> If you use a remote filesystem, you should switch ArchiveBox's search backend from [`ripgrep`](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Search#ripgrep) to [`sonic`](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Search#sonic) (or [`FTS5`](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Search#fts5)). > If you use a remote filesystem, you should switch ArchiveBox's search backend from [`ripgrep`](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Search#ripgrep) to [`sonic`](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Search#sonic) (or [`FTS5`](https://github.com/ArchiveBox/ArchiveBox/wiki/Setting-up-Search#fts5)).
> <sub>(`ripgrep` scans over every byte in the archive to do each search, which is **slow and potentially costly** on remote cloud storage)</sub> > <sub>(`ripgrep` scans over every byte in the archive to do each search, which is **slow and potentially costly** on remote cloud storage)</sub>
<a name="nfs"></a>
### `NFS` (Docker Driver) ### `NFS` (Docker Driver)
`docker-compose.yml`: `docker-compose.yml`:
@@ -129,6 +140,8 @@ volumes:
device: ":/archivebox-archive" device: ":/archivebox-archive"
``` ```
<a name="smb"></a><a name="ceph"></a>
### `SMB` / `Ceph` (Docker CIFS Driver) ### `SMB` / `Ceph` (Docker CIFS Driver)
`docker-compose.yml`: `docker-compose.yml`:
@@ -152,6 +165,8 @@ volumes:
<img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/0a159c27-5d54-46b9-814b-480f239ed27e" alt="local filesystem icon" height="80px" align="right"/><img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/5ca561b4-4597-401f-84b6-d53042fd7359" alt="local filesystem icon" height="80px" align="right"/> <img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/0a159c27-5d54-46b9-814b-480f239ed27e" alt="local filesystem icon" height="80px" align="right"/><img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/5ca561b4-4597-401f-84b6-d53042fd7359" alt="local filesystem icon" height="80px" align="right"/>
<a name="s3"></a><a name="b2"></a><a name="gdrive"></a><a name="rclone"></a>
### Amazon S3 / Backblaze B2 / Google Drive / etc. (RClone) ### Amazon S3 / Backblaze B2 / Google Drive / etc. (RClone)
```bash ```bash