Skip to content

Commit cec5084

Browse files
committed
chore: Document install.sh
1 parent ed10eca commit cec5084

File tree

2 files changed

+25
-9
lines changed

2 files changed

+25
-9
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,23 @@ When mounted with the [Tigris](https://www.tigrisdata.com) backend TigrisFS supp
3434

3535
# Installation
3636

37+
## Recommended: One-line install
38+
39+
```bash
40+
curl -sSL https://raw.githubusercontent.com/tigrisdata/tigrisfs/refs/heads/main/install.sh | bash
41+
```
42+
3743
## Prebuilt DEB and RPM packages
3844

39-
* Download the latest release: [DEB](https://github.com/tigrisdata/tigrisfs/releases/download/v1.2.0/tigrisfs_1.2.0_linux_amd64.deb), [RPM](https://github.com/tigrisdata/tigrisfs/releases/download/v1.2.0/tigrisfs_1.2.0_linux_amd64.rpm).
45+
* Download the latest release: [DEB](https://github.com/tigrisdata/tigrisfs/releases/download/v1.3.0/tigrisfs_1.3.0_linux_amd64.deb), [RPM](https://github.com/tigrisdata/tigrisfs/releases/download/v1.3.0/tigrisfs_1.3.0_linux_amd64.rpm).
4046
* Install the package:
4147
* Debian-based systems:
4248
```bash
43-
dpkg -i tigrisfs_1.2.0_linux_amd64.deb
49+
dpkg -i tigrisfs_1.3.0_linux_amd64.deb
4450
```
4551
* RPM-based systems:
4652
```bash
47-
rpm -i tigrisfs_1.2.0_linux_amd64.rpm
53+
rpm -i tigrisfs_1.3.0_linux_amd64.rpm
4854
```
4955
* Configure credentials
5056
TigrisFS can use credentials from different sources:
@@ -71,7 +77,7 @@ See [docs](https://www.tigrisdata.com/docs/sdks/s3/aws-cli/) for more details.
7177
* Download and unpack the latest release:
7278
* MacOS ARM64
7379
```
74-
curl -L https://github.com/tigrisdata/tigrisfs/releases/download/v1.2.0/tigrisfs_1.2.0_darwin_arm64.tar.gz | sudo tar -xz -C /usr/local/bin
80+
curl -L https://github.com/tigrisdata/tigrisfs/releases/download/v1.3.0/tigrisfs_1.3.0_darwin_arm64.tar.gz | sudo tar -xz -C /usr/local/bin
7581
```
7682
* Configuration is the same as for the DEB and RPM packages above.
7783
* Mount the bucket:

install.sh

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -520,9 +520,9 @@ install_macfuse_via_homebrew() {
520520
# Function to handle macFUSE installation with multiple methods
521521
ensure_macfuse_installed() {
522522
# Skip if not on macOS
523-
# if [ "$(detect_os)" != "darwin" ]; then
524-
# return 0
525-
# fi
523+
if [ "$(detect_os)" != "darwin" ]; then
524+
return 0
525+
fi
526526

527527
# Check if already installed
528528
if check_macfuse_installed; then
@@ -777,14 +777,24 @@ main() {
777777
# Verify installation
778778
if command_exists "$BINARY_NAME"; then
779779
print_success "Installation completed successfully!"
780-
print_info "Run '$BINARY_NAME --help' to get started"
781780

782781
# Show version if possible
783782
if "$BINARY_NAME" --version >/dev/null 2>&1; then
784783
local version
785784
version=$("$BINARY_NAME" --version 2>&1| head -n1 | cut -d ' ' -f 3)
786-
print_info "Installed version: $version"
785+
print_info "Installed version: ${GREEN}$version${NC}"
786+
fi
787+
788+
if [ "$package_type" = "tar.gz" ]; then
789+
print_info "Run '$BINARY_NAME --help' to get started"
790+
else
791+
print_info "Configure credentials in:
792+
/etc/default/tigrisfs - global
793+
/etc/default/tigrisfs-<bucket> - per bucket"
794+
print_info "Run 'systemctl --user start tigrisfs@<bucket>' to mount the bucket
795+
'systemctl --user stop tigrisfs@<bucket>' to unmount the bucket"
787796
fi
797+
788798
else
789799
if [ "$package_type" = "tar.gz" ]; then
790800
print_warning "Installation completed, but $BINARY_NAME is not in PATH"

0 commit comments

Comments
 (0)