planet/docs/technical/en/quickstart.md

Quickstart

This quickstart is for Intelligent Planet end users who just received an access URL and need the shortest path from "open the browser" to "first useful configuration done". Every action happens in the browser.

If you are responsible for deployment or operations, read the Intelligent Planet Ops Runbook instead.

1. Open the URL

Open the URL your administrator gave you, e.g. http://planet.example.com. A local demo is usually http://localhost:3000.

Entry points are split in two:

• Public: /earth (3D situational view), /docs (public documentation)
• Login required: /admin (console), /ai (AI), /settings (system settings), /earth-content (Earth content), /collection-management (collection management)

2. Register

1. Open /login and click "Register" under the form.
2. On /register, fill in username, email, password (≥ 8 characters).
3. After submission, check your inbox for a 6-digit verification code (valid for 10 minutes).
4. Enter the code on the verify page and click "Verify and Sign In". You are taken to the console automatically.

If the email does not arrive:

• Check spam and your enterprise mail gateway
• The "Resend Code" button has a countdown; you can resend once it ends
• A "Email service not configured" message means your administrator has not yet set up SMTP — please ping them

The default role is viewer: you can sign in but only see public pages. For collectors, user management, or system settings, ask the admin to promote your role or add Gatekeeper groups.

3. First Sign-In Checklist

After landing on the /admin dashboard, here's a recommended walk-through:

1. /collection-management?section=collector_credentials: pick a collector and click the plug icon to test connectivity. Free collectors (e.g. open BGP) usually work right away; credential-bearing ones like AISStream or BarentsWatch need an API key / client secret first
2. /ai?section=integrations: fill an LLM provider (e.g. minimax / openai), model, base URL, API key, and click the plug at the end of the base URL to check the model catalog; verify generation in Playground. The refresh icon updates and saves the available model catalog while preserving your form; select a model and click Save to apply it. WebSearch / OCR tools are optional
3. /earth-content?section=brand: maintain the Earth HUD logo and title image in Branding. The Upload button inside each URL field opens a file picker, and image files can also be dropped directly onto the matching field. Save the brand configuration after upload
4. /datasources or /data: check whether collectors have produced data. Use /datasources -> Built-in Sources for finite collectors: with no rows selected, click Trigger All; after selecting rows, the primary button becomes Trigger Selected N. The top-right queue button shows progress. Use /datasources -> Realtime Sources for AISStream / WebSocket health and counters
5. /alerts/system: verify system alerts look right
6. /users (super_admin only): open accounts for teammates or adjust their groups

4. Open Earth

Visit /earth. This is a public page — no login required.

If the system has no collected data yet, Earth shows an initialization guide that points you to sign in and trigger collection. This guide is backend-state driven, so clearing browser storage does not make it appear once the system is ready.

Once in, verify:

• The globe renders, and the right-side layer panel can toggle layers
• Search finds cables, satellites, compute centers, BGP events
• Compute-center and BGP collector detail cards can collect coordinate candidates and preview them on Earth
• Close the candidate panel or switch browser tabs during batch location, then return to see progress; refreshing or leaving Earth interrupts unfinished work
• The vessel layer receives ongoing AISStream / BarentsWatch positions and reconciles after reconnecting
• The live-stream menu searches the complete channel catalog and loads more on scroll; Al Jazeera Mubasher is the default
• Mouse drag, wheel zoom, and the zoom percentage indicator work
• The settings panel can switch rotate / cruise / motion modes; motion settings can select the input source and allowed gestures; view settings can switch hover tooltip content, and satellite settings can toggle real-altitude layering and track display

5. Recover a Lost Password

Open /forgot-password, enter your email, receive a code, then enter the code plus a new password. The same confirmation is shown for unknown emails (to avoid enumeration).

6. Read the Docs

/docs is the docs site. Without login you can read: this Quickstart, the Manual, the FAQ. Authenticated users with docs_user / docs_developer / docs_admin groups see additional technical documents.

Next Steps

• Full UI walkthrough: Intelligent Planet Manual
• Troubleshooting and configuration questions: FAQ
• Detailed Earth coordinate candidate flow: see the Earth section in Intelligent Planet Manual
• Deployment / operations commands: Intelligent Planet Ops Runbook