Skip to content

chore: Document install.sh #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
efirs merged 1 commit into from
Jun 30, 2025
Merged

chore: Document install.sh #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,23 @@ When mounted with the [Tigris](https://www.tigrisdata.com) backend TigrisFS supp

# Installation

## Recommended: One-line install

```bash
curl -sSL https://raw.githubusercontent.com/tigrisdata/tigrisfs/refs/heads/main/install.sh | bash
```

## Prebuilt DEB and RPM packages

* 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).
* Download the latest release: [DEB](https://github.com/tigrisdata/tigrisfs/releases/download/v1.2.1/tigrisfs_1.2.1_linux_amd64.deb), [RPM](https://github.com/tigrisdata/tigrisfs/releases/download/v1.2.1/tigrisfs_1.2.1_linux_amd64.rpm).
* Install the package:
* Debian-based systems:
```bash
dpkg -i tigrisfs_1.2.0_linux_amd64.deb
dpkg -i tigrisfs_1.2.1_linux_amd64.deb
```
* RPM-based systems:
```bash
rpm -i tigrisfs_1.2.0_linux_amd64.rpm
rpm -i tigrisfs_1.2.1_linux_amd64.rpm
```
* Configure credentials
TigrisFS can use credentials from different sources:
Expand All @@ -71,7 +77,7 @@ See [docs](https://www.tigrisdata.com/docs/sdks/s3/aws-cli/) for more details.
* Download and unpack the latest release:
* MacOS ARM64
```
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
curl -L https://github.com/tigrisdata/tigrisfs/releases/download/v1.2.1/tigrisfs_1.2.1_darwin_arm64.tar.gz | sudo tar -xz -C /usr/local/bin
```
* Configuration is the same as for the DEB and RPM packages above.
* Mount the bucket:
Expand Down
20 changes: 15 additions & 5 deletions install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,9 +520,9 @@ install_macfuse_via_homebrew() {
# Function to handle macFUSE installation with multiple methods
ensure_macfuse_installed() {
# Skip if not on macOS
# if [ "$(detect_os)" != "darwin" ]; then
# return 0
# fi
if [ "$(detect_os)" != "darwin" ]; then
return 0
fi

# Check if already installed
if check_macfuse_installed; then
Expand Down Expand Up @@ -777,14 +777,24 @@ main() {
# Verify installation
if command_exists "$BINARY_NAME"; then
print_success "Installation completed successfully!"
print_info "Run '$BINARY_NAME --help' to get started"

# Show version if possible
if "$BINARY_NAME" --version >/dev/null 2>&1; then
local version
version=$("$BINARY_NAME" --version 2>&1| head -n1 | cut -d ' ' -f 3)
print_info "Installed version: $version"
print_info "Installed version: ${GREEN}$version${NC}"
fi

if [ "$package_type" = "tar.gz" ]; then
print_info "Run '$BINARY_NAME --help' to get started"
else
print_info "Configure credentials in:
/etc/default/tigrisfs - global
/etc/default/tigrisfs-<bucket> - per bucket"
print_info "Run 'systemctl --user start tigrisfs@<bucket>' to mount the bucket
'systemctl --user stop tigrisfs@<bucket>' to unmount the bucket"
fi

else
if [ "$package_type" = "tar.gz" ]; then
print_warning "Installation completed, but $BINARY_NAME is not in PATH"
Expand Down