You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,12 +44,14 @@ The history of `dstack` Enterprise releases can be found in the [`dstackai/dstac
44
44
`dstack` is backward compatible within its major version. For example, if `dstack` Enterprise
45
45
is `0.18.1-v1`, the version of CLI or API must start with `0.18`.
46
46
47
-
## Configuring environment variables
47
+
## Environment variables
48
48
49
49
Here's the list of environment variables which you can override:
50
50
51
-
*`DSTACK_SERVER_DIR` – (Optional) The path to the directory where the dstack server stores the state. Defaults to `/root/.dstack/server`.
52
-
*`DSTACK_SERVER_ADMIN_TOKEN` – (Optional) The default token of the admin user. By default, it's generated randomly at the first startup.
51
+
-`DSTACK_SERVER_DIR` – (Optional) The path to the directory where the `dstack` server stores the state. Defaults to `/root/.dstack/server`.
52
+
-`DSTACK_DATABASE_URL` – (Optional) The database URL to use instead of default SQLite. Currently `dstack` supports Postgres. Example: `postgresql+asyncpg://myuser:mypassword@localhost:5432/mydatabase`.
53
+
-`DSTACK_SERVER_ADMIN_TOKEN` – (Optional) The default token of the `admin` user. By default, it's generated randomly
54
+
at the first startup.
53
55
54
56
## Configuring backends
55
57
@@ -71,14 +73,16 @@ Upon restart, it will resume tracking their states.
71
73
72
74
## Persisting state
73
75
74
-
`dstack` stores its state in the ``$DSTACK_SERVER_DIR/data`` folder (by default `/root/.dstack/server/data`) with SQLite.
76
+
By default, `dstack` stores its state in `~/.dstack/server/data` using SQLite.
77
+
To use a database, set the `DSTACK_DATABASE_URL` environment variable (see below).
75
78
76
-
### Persisting state with Litestream
79
+
### Replicate SQLite state via Litestream
77
80
78
-
If required, `dstack`can automatically replicate its state to a cloud object storage via [Litestream](https://litestream.io/getting-started/) by configuring the
79
-
necessary environment variables.
81
+
If not using `DSTACK_DATABASE_URL`, you can still replicate the state to cloud object storage using Litestream. To do
82
+
this, you need to set the following environment variables.
80
83
81
-
*`LITESTREAM_REPLICA_URL` - The url of the cloud object storage. Examples: `s3://<bucket name>/<path>`, `gcs://<bucket name>/<path>`, `abs://<storage account>@<container name>/<path>`, etc.
84
+
-`LITESTREAM_REPLICA_URL` - The url of the cloud object storage.
85
+
Examples: `s3://<bucket-name>/<path>`, `gcs://<bucket-name>/<path>`, `abs://<storage-account>@<container-name>/<path>`, etc.
82
86
83
87
#### AWS S3
84
88
@@ -126,10 +130,8 @@ During deployment, it’s important to configure `DSTACK_SERVER_ADMIN_TOKEN`. Th
126
130
127
131
### Authentication
128
132
129
-
Currently, `dstack` Enterprise allows authentication using personal access tokens. Each user has their personal token, which can be found or changed in the user's account settings. This token must be used for authentication to access both the UI, CLI, or API.
133
+
Currently, `dstack` Enterprise allows authentication using personal user tokens. Each user has their own token, which can be found or changed in the user's account settings. This token must be used for authentication to access the control plane, CLI, or API.
130
134
131
-
### Managing projects
135
+
### Projects
132
136
133
-
Projects group and isolate users and resources. It's possible to create multiple projects, configure different clouds for each project, and grant different users access to these projects.
134
-
135
-
Once a project is configured, a user with `Admin` role can manage the project members.
137
+
Projects enable the isolation of different teams and their resources. Check out the [Projects](https://github.com/dstackai/dstack-enterprise/wiki/Projects) wiki page for more details on how to manage projects.
0 commit comments