Skip to content

Commit 8d3da0f

Browse files
committed
docs: update self-hosted API Docker command example
1 parent fbd6b45 commit 8d3da0f

File tree

1 file changed

+4
-19
lines changed

1 file changed

+4
-19
lines changed

resources/guides/using-a-self-hosted-api-server.ipynb

+4-19
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,10 @@
2626
"\n",
2727
"### From the Docker image\n",
2828
"\n",
29-
"Alternatively, you can download and run the [`opvious/api-server`](https://hub.docker.com/r/opvious/api-server) Docker image directly. This allows you to use it with your own database and/or cache:\n",
29+
"Alternatively, you can download and run the [`opvious/api-server`](https://hub.docker.com/r/opvious/api-server) Docker image directly:\n",
3030
"\n",
3131
"```\n",
32-
"docker run -p 8080:8080 \\\n",
33-
" -e DB_URL=postgres:// \\\n",
34-
" -e REDIS_URL=redis:// \\\n",
35-
" -e OPVIOUS_API_IMAGE_EULA \\\n",
36-
" opvious/api-server\n",
32+
"docker run -p 8080:8080 opvious/api-server\n",
3733
"```\n",
3834
"\n",
3935
"Refer to the image's documentation for more information.\n",
@@ -55,18 +51,7 @@
5551
"profiles:\n",
5652
" - name: local\n",
5753
" endpoint: http://localhost:8080\n",
58-
"```\n",
59-
"\n",
60-
"\n",
61-
"## Authenticating requests\n",
62-
"\n",
63-
"The server's `STATIC_TOKENS` environment variable is used to specify a comma-separated list of static API tokens for authenticating API requests. Each entry's format is `<email>=<token>`, where `<email>` is the associated account's email. When using the CLI, this variable is set with the `-t` option:\n",
64-
"\n",
65-
"```sh\n",
66-
"opvious api start -t [email protected]=secret-token\n",
67-
"```\n",
68-
"\n",
69-
"These tokens can then be used as regular API tokens in SDKs by prefixing them with `static:`. For example requests to the server started with the command just above can be authenticated as `[email protected]` by setting `OPVIOUS_TOKEN=static:secret-token`."
54+
"```"
7055
]
7156
},
7257
{
@@ -94,7 +79,7 @@
9479
"name": "python",
9580
"nbconvert_exporter": "python",
9681
"pygments_lexer": "ipython3",
97-
"version": "3.12.5"
82+
"version": "3.12.7"
9883
}
9984
},
10085
"nbformat": 4,

0 commit comments

Comments
 (0)