Skip to content

Add FESS_VERSION environment variable to README documentation #20

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
marevol merged 1 commit into from
Aug 23, 2025
Merged

Add FESS_VERSION environment variable to README documentation #20

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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ fessctl --help

```bash
export FESS_ACCESS_TOKEN=...
export FESS_VERSION=15.1.0
fessctl ping
fessctl user list
fessctl webconfig create --name TestConfig --url https://test.config.com/
Expand All @@ -57,15 +58,17 @@ docker build -t fessctl:latest .

You need to provide the following environment variables when running:

- FESS_ENDPOINT: The URL of your Fess server’s API endpoint. (Default: `http://localhost:8080`)
- FESS_ENDPOINT: The URL of your Fess server's API endpoint. (Default: `http://localhost:8080`)
- FESS_ACCESS_TOKEN: Your access token to authenticate with the Fess API.
- FESS_VERSION: Your Fess server version for API compatibility. (Default: `15.1.0`)

Example:

```bash
docker run --rm \
-e FESS_ENDPOINT=https://your-fess-server \
-e FESS_ACCESS_TOKEN=your_access_token_here \
-e FESS_VERSION=15.1.0 \
fessctl --help
```

Expand All @@ -75,6 +78,7 @@ To run an actual command, for example:
docker run --rm \
-e FESS_ENDPOINT=https://your-fess-server \
-e FESS_ACCESS_TOKEN=your_access_token_here \
-e FESS_VERSION=15.1.0 \
fessctl webconfig list
```

Expand Down