|
26 | 26 | "\n",
|
27 | 27 | "### From the Docker image\n",
|
28 | 28 | "\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", |
30 | 30 | "\n",
|
31 | 31 | "```\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", |
37 | 33 | "```\n",
|
38 | 34 | "\n",
|
39 | 35 | "Refer to the image's documentation for more information.\n",
|
|
55 | 51 | "profiles:\n",
|
56 | 52 | " - name: local\n",
|
57 | 53 | " 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 | + "```" |
70 | 55 | ]
|
71 | 56 | },
|
72 | 57 | {
|
|
94 | 79 | "name": "python",
|
95 | 80 | "nbconvert_exporter": "python",
|
96 | 81 | "pygments_lexer": "ipython3",
|
97 |
| - "version": "3.12.5" |
| 82 | + "version": "3.12.7" |
98 | 83 | }
|
99 | 84 | },
|
100 | 85 | "nbformat": 4,
|
|
0 commit comments