Skip to content

Commit

Permalink
docs: PHOENIX_WORKING_DIR default value documentation (#3190)
Browse files Browse the repository at this point in the history
* default location for PHOENIX_WORKING_DIR

* Update configuration.md
  • Loading branch information
MartinoMensio committed May 14, 2024
1 parent e3f6e08 commit 6957bd9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/deployment/persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Persistence is only available for 'arize-phoenix>=4.0.0'

## SQLite

By default Phoenix uses SQLite so that it runs with no external dependancies. This SQLite instance is by default mounted in the directory specified by the **PHOENIX\_WORKING\_DIR** environment variable. The easiest way to make Phoenix to persist data is to back this working directory to a mounted volume. Attach the mounted volume to the phoenix pod and point **PHOENIX\_WORKING\_DIR** to that volume (e.x. `/mnt/volume`)\
By default Phoenix uses SQLite so that it runs with no external dependancies. This SQLite instance is by default mounted in the directory specified by the **PHOENIX\_WORKING\_DIR** environment variable (default value in your home directory, e.x. ` ~/.phoenix/`). The easiest way to make Phoenix to persist data is to back this working directory to a mounted volume. Attach the mounted volume to the phoenix pod and point **PHOENIX\_WORKING\_DIR** to that volume (e.x. `/mnt/volume`)\


## PostgreSQL
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ The following environment variables will control how your phoenix server runs.

* **PHOENIX\_PORT:** The port to run the phoenix web server. Defaults to 6006.
* **PHOENIX\_GRPC\_PORT:** The port to run the gRPC OTLP trace collector. Defaults to 4317.
*  **PHOENIX\_HOST:** The host to run the phoenix server. Defaults to 0.0.0.0 
*  **PHOENIX\_WORKING\_DIR:** The directory in which to save, load, and export datasets. This directory must be accessible by both the Phoenix server and the notebook environment. 
* **PHOENIX\_HOST:** The host to run the phoenix server. Defaults to 0.0.0.0
* **PHOENIX\_WORKING\_DIR:** The directory in which to save, load, and export datasets. This directory must be accessible by both the Phoenix server and the notebook environment. Defaults to `~/.phoenix/`
* **PHOENIX\_SQL\_DATABASE\_URL:** The SQL database URL to use when logging traces and evals. if you plan on using SQLite, it's advised to to use a persistent volume and simply point the `PHOENIX_WORKING_DIR` to that volume. If URL is not specified, by default Phoenix starts with a file-based SQLite database in a temporary folder, the location of which will be shown at startup. Phoenix also supports PostgresSQL as shown below:
* PostgreSQL, e.g. `postgresql://@host/dbname?user=user&password=password` or `postgresql://user:password@host/dbname`
* SQLite, e.g. `sqlite:///path/to/database.db`
Expand Down

0 comments on commit 6957bd9

Please sign in to comment.