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: docs/getting-started/quickstart.mdx
+97-4Lines changed: 97 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,8 +142,16 @@ The OpenTDF Platform is the core service that enforces attribute-based access co
142
142
143
143
You'll run a local instance using Docker. This includes the [Platform](https://github.com/opentdf/platform/tree/main), [Keycloak](https://www.keycloak.org/) (for user authentication), and [PostgreSQL](https://www.postgresql.org/) (for storing attributes and policies).
144
144
145
-
:::warning
146
-
Not for production use.
145
+
:::danger ⚠️ EVALUATION AND DEVELOPMENT ONLY
146
+
**This quickstart setup is NOT intended for production use.**
147
+
148
+
This configuration uses:
149
+
- Self-signed certificates
150
+
- Default credentials and secrets
151
+
- Insecure TLS settings
152
+
- No data persistence guarantees
153
+
154
+
For production deployment guidance, visit: https://opentdf.io
147
155
:::
148
156
149
157
#### Step 1: Check Prerequisites
@@ -161,6 +169,10 @@ chmod +x check.sh
161
169
./check.sh
162
170
```
163
171
172
+
:::note Sudo Password Prompt
173
+
You may be prompted for your sudo password during the "Checking permissions..." step. This is needed to verify write access to `/etc/hosts` (required for adding local domain mappings) and to check Docker permissions.
174
+
:::
175
+
164
176
<details>
165
177
<summary>Expected output</summary>
166
178
@@ -186,10 +198,10 @@ Checking disk space...
186
198
✓ Disk space: 50GB available
187
199
188
200
Checking port availability...
201
+
✓ Port 8080 is available
189
202
✓ Port 8443 is available
190
203
✓ Port 9443 is available
191
204
✓ Port 2019 is available
192
-
✓ Port 5432 is available
193
205
194
206
Checking permissions...
195
207
✓ sudo access available (will prompt for password)
@@ -208,7 +220,7 @@ Ready to install OpenTDF:
208
220
The script checks:
209
221
- Docker is installed and running
210
222
- Docker Compose is available
211
-
- Required ports are available (8443, 9443, 2019, 5432)
223
+
- Required ports are available (8080, 8443, 9443, 2019)
On Linux systems, you may see a warning: `Warning: Keyring storage is not available on Linux`. This is a known limitation. As a workaround, you can create the profile with credentials in one command:
0 commit comments