Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation around instances #32

Open
Sytten opened this issue Sep 20, 2023 · 2 comments
Open

Add documentation around instances #32

Sytten opened this issue Sep 20, 2023 · 2 comments
Assignees

Comments

@Sytten
Copy link
Member

Sytten commented Sep 20, 2023

We need to do a better job explaining the concept of instances.

  • Explain what a caido instance is
  • Explain how to reset the instances (link to Common errors)
  • Explain how to have multiple instances on the same machine
@Sytten
Copy link
Member Author

Sytten commented Oct 2, 2023

Place this page in Internals

@Sytten
Copy link
Member Author

Sytten commented Oct 2, 2023

  • VPS = Virtual private server
  • localhost = 127.0.0.1
  • The logic unit in the Caido Ecosystem is the Caido Instance.
    • When you click start in Desktop, you start an instance
    • You can local instances (on your own machine) or remote instances (on your VPS, in the cloud, etc)
    • Instances register themselves in Caido cloud when they start
      • Instances are claimed by user at the first login
      • Nobody else can access this instance, it is bound to your account
      • They gain credentials unique to that instance, that is why you need to send --reset-credentials when you want to change account
  • New instance = New instance connection
    • Local (L)
      • Connection name
      • Interface on which it listens
        • localhost = your own computer
        • all interface (0.0.0.0) = accessible from the network / internet
      • port
    • Remote (R)
      • Host + port
      • Test the connection to see if it is reachable

@Sytten Sytten assigned ninjeeter and unassigned charliebousquet May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants