Skip to content

Remote Hosting Tutorial#355

Open
ninjeeter wants to merge 4 commits into
mainfrom
AP-Remote-Hosting
Open

Remote Hosting Tutorial#355
ninjeeter wants to merge 4 commits into
mainfrom
AP-Remote-Hosting

Conversation

@ninjeeter
Copy link
Copy Markdown
Contributor

Closes #332

Copilot AI review requested due to automatic review settings May 12, 2026 14:07
@ninjeeter ninjeeter requested a review from Corb3nik May 12, 2026 14:07
@github-actions
Copy link
Copy Markdown
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 74.8%, saving 202.3 KB.

Filename Before After Improvement Visual comparison
src/_images/remote_instance_desktop.png 270.5 KB 68.2 KB 74.8% View diff

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Remote Hosting” tutorial to improve the onboarding/journey for running Caido CLI on a remote host and connecting to it from a local device, and links it from the Tutorials sidebar.

Changes:

  • Introduces a new tutorial covering standalone and Docker-based remote hosting, SSH tunneling, and internet exposure via Nginx or Docker+Traefik.
  • Adds “Remote Hosting” to the app tutorials sidebar navigation.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 11 comments.

File Description
src/app/tutorials/remote.md New tutorial page documenting multiple remote hosting approaches and access patterns.
.vitepress/sidebars/app/tutorials.ts Adds the new tutorial to the “Configuration” section of the tutorials sidebar.

Comment thread src/app/tutorials/remote.md
Comment thread src/app/tutorials/remote.md Outdated
Comment thread src/app/tutorials/remote.md
Comment thread src/app/tutorials/remote.md Outdated
Comment thread src/app/tutorials/remote.md Outdated
Comment thread src/app/tutorials/remote.md
Comment thread src/app/tutorials/remote.md Outdated
Comment thread src/app/tutorials/remote.md Outdated
Comment thread src/app/tutorials/remote.md
Comment thread src/app/tutorials/remote.md
@github-actions
Copy link
Copy Markdown
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 11.1%, saving 7.6 KB.

Filename Before After Improvement Visual comparison
src/_images/remote_instance_desktop.png 68.2 KB 60.6 KB 11.1% View diff

./caido-cli
```

### Docker Image Container
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section looks pretty complicated, given that you have to fetch uid/gid related stuff in order to setup a volume.

Can we instead use a docker compose file? Setting up the volume is a lot easier that way.


### Docker Image Container

The Caido CLI can also be launched as a Docker image container. To download the latest release, ensure [Docker Engine](https://docs.docker.com/engine/install/) is installed and the Docker daemon is running (_`sudo systemctl status docker`_) or launched (_`sudo systemctl start docker`_), and enter:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sudo systemctl status docker is linux specific. If a windows or a macos user reads this, they can't really apply this step.


In a browser on your local device, navigate to `http://127.0.0.1:<local-port>` to access the Caido GUI.

## Exposing an Instance to the Internet
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the difference between this tutorial and the "Exposing an Instance to the Internet" tutorial?

Should we get rid of the old one?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a lot of overlap between our existing guides, the current "Exposing Caido to the Internet" guide, and this.

Checked with Emile a bit, and we have more information: https://discord.com/channels/843915806748180492/1504112101675896934/1504115119615901846

Can you restructure this tutorial to solve Emile's problem posted above?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Better user journey for remote hosting

4 participants