Skip to content

Commit 5dc61d0

Browse files
committed
docs: Update README
1 parent e1d943c commit 5dc61d0

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,42 @@ It solves these problems by using aggressive parallelism and asynchrony.
1616

1717
The goal of TigrisFS is to further improve on performance and reliability especially in distributed cluster setup.
1818

19-
In first release we worked on improving reliability of the code base:
20-
* Removed bundled, outdated AWS SDK with critical vulnerabilities.
21-
* Upgraded dependencies to fix security vulnerabilities.
22-
* Enabled race detector in tests and fixed all detected race conditions.
23-
* Enabled unit, xfs and cluster tests on every PR and push to main.
19+
In the first release we focused on improving security and reliability of the code base:
20+
* Improved security by:
21+
* removing bundled, outdated AWS SDK with critical vulnerabilities.
22+
* upgrading dependencies to fix security vulnerabilities.
23+
* Improved reliability by:
24+
* fixing all race conditions found by race detector, which is now enabled by default in tests.
25+
* fixing all linter issues and enabling linting by default in CI.
26+
* running more extensive tests and enabling them by default in CI.
27+
28+
## Tigris specific features
29+
30+
When mounted with the [Tigris](https://www.tigrisdata.com) backend TigrisFS supports:
31+
* POSIX permissions, special files, symbolic links.
32+
* Allows to auto prefetch directory data to the region on list.
2433

2534
# Installation
2635

2736
## Prebuilt DEB and RPM packages
2837

29-
* Download the latest release: [DEB](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.0/tigrisfs_tigris_1.1.0_linux_amd64.deb), [RPM](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.0/tigrisfs_tigris_1.1.0_linux_amd64.rpm).
38+
* Download the latest release: [DEB](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.2/tigrisfs_1.1.2_linux_amd64.deb), [RPM](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.2/tigrisfs_1.1.2_linux_amd64.rpm).
3039
* Install the package:
3140
* Debian-based systems:
3241
```bash
33-
dpkg -i tigrisfs_tigris_1.1.0_linux_amd64.deb
42+
dpkg -i tigrisfs_1.1.2_linux_amd64.deb
3443
```
3544
* RPM-based systems:
3645
```bash
37-
rpm -i tigrisfs_tigris_1.1.0_linux_amd64.rpm
46+
rpm -i tigrisfs_1.1.2_linux_amd64.rpm
3847
```
3948
* Configure credentials
4049
TigrisFS can use credentials from different sources:
4150
* Standard AWS credentials files `~/.aws/credentials` and `~/.aws/config`. Use `aws configure` to set them up and export
4251
`AWS_PROFILE` environment variable to use a specific profile.
4352
* Environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`.
4453
* TigrisFS credentials in `/etc/default/tigrisfs` or mount specific credentials in `/etc/default/tigrisfs-<bucket>`.
54+
See [docs](https://www.tigrisdata.com/docs/sdks/s3/aws-cli/) for more details.
4555

4656
* Mount the bucket
4757
* as current user
@@ -60,7 +70,7 @@ In first release we worked on improving reliability of the code base:
6070
* Download and unpack the latest release:
6171
* MacOS ARM64
6272
```
63-
curl -L https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.0/tigrisfs_tigris_1.1.0_darwin_arm64.tar.gz | tar -xz -C /usr/local/bin
73+
curl -L https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.2/tigrisfs_1.1.2_darwin_arm64.tar.gz | tar -xz -C /usr/local/bin
6474
```
6575
* Configuration is the same as for the DEB and RPM packages above.
6676
* Mount the bucket:

0 commit comments

Comments
 (0)