Help

CodepuppyIO gives your project a free address like pixel-garden.vibepuppy.app. You can share it with everyone or keep it private, and it can even run on a computer at home. Here's how it all works.

Get started

  1. Pick a name. Type it into the box on the home page to see if it's available. Names use lowercase letters, numbers and hyphens, 3 to 32 characters long.
  2. Create a free account with Get started, or sign in.
  3. Add the project. Give it a title and a short description, and paste the URL where it runs today: Vercel, Netlify, GitHub Pages, a VPS, anything with a public address.
  4. Verify it (below). Once that's done, the address goes live.

You can also add a project with no address at all, just to list it in the directory with its own link.

Every public project, with or without an address, gets a showcase page at codepuppy.io/p/your-project. It shows the project and its description, who made it and their other projects, and lets signed-in members like it and leave comments. Change the link under Edit on the project card, and find it in the card's ⋯ menu. You can remove any comment on your own projects.

You also get a profile page at codepuppy.io/u/your-username with your name, photo and all your public projects. Your username is picked from your name; change it in your profile, from your photo in the sidebar. Your country and city are never shown there.

Verify your address

Verifying proves that the site really is yours, so nobody can put a CodepuppyIO address on someone else's site.

  1. When you add a project, CodepuppyIO shows you a key and a file location: a file called codepuppy.claim at the URL you entered, such as https://you.github.io/pixel-garden/codepuppy.claim.
  2. Create that file on your site, with the key as its only content, and publish your site.
  3. Press Verify on the project card.

You have 24 hours. A new name is held for you for 24 hours while you set it up. If it isn't verified by then, the name becomes available to others again. Setting the address again gives you a new key and another 24 hours.

If Verify fails, open the file's URL in your browser. It should show the key and nothing else. Some hosts take a minute or two to publish a change.

The CodepuppyIO team reviews new addresses. A project that isn't a project, shows content that isn't allowed, is spam or is fraud may be rejected. A rejected project is removed and its address released, and you're told why in your Inbox and by email. If you think we got it wrong, open the message in your Inbox and press Disagree. The CodepuppyIO team answers there, and you get an email when we do.

Private sites and share links

Any project with an address can be public or private. Public projects appear in the directory for anyone to find. Private ones open only for you and the people you share them with, and are never listed.

To share a private site, open Sharing on its project card and make a share link. Anyone who opens the link and signs in gets access.

  • Turn a link off to stop new people joining through it. People who already joined keep access.
  • Remove a person to take their access away straight away. They can't rejoin through a share link unless you allow them again.

Opening a private site

If someone sent you a share link, open it. You'll be asked to sign in to CodepuppyIO, or to continue as a guest:

  • With an account: sign in or create one, and you're taken to the site.
  • As a guest: enter your name and email. We email you a link that opens the site. It works once and expires after 30 minutes. If it has expired, open the share link again to get a new one.

If the site says the link was turned off or isn't valid, ask the owner for a new one.

Run it on a home server

Got a project running on a computer at home, such as a Raspberry Pi or an old laptop? The CodepuppyIO tunnel app connects it to its address. It keeps one outbound connection open, so you don't need port forwarding or a public IP, and it works behind carrier-grade NAT.

  1. Choose New project and then On my own server.
  2. Copy the install command it shows. It contains your project's token, so keep it private.
  3. Run it on your server. --to is where your web server listens on that machine:
curl -fsSL https://codepuppy.io/install-tunnel.sh | sudo sh -s -- --name pixel-garden --token cpt_… --to http://localhost:3000

A home server is private, and its address is on .codepuppy.online, for example pixel-garden.codepuppy.online. It goes live as soon as the app connects. To make it public, turn off Private: it then uses one of your free .vibepuppy.app addresses, and you verify it with the claim file like any other site. Your server answers /codepuppy.claim with the key, and CodepuppyIO reads it through the app, so the app has to be connected when you press Verify.

The app runs as a service, starts when the machine boots and reconnects by itself. It needs Linux with systemd on x86_64, arm64 or armv7.

Everyday commands

codepuppy-tunnel list                               # your tunnels and whether they're connected
journalctl -u codepuppy-tunnel@pixel-garden -f      # watch the logs
sudo codepuppy-tunnel uninstall --name pixel-garden # stop and remove

Need the command again, to install on another machine or to update the app to the latest version? Choose Install command in the project's ⋯ menu and run it. It installs the latest version and restarts the app.

Think someone saw your token? Choose New app token in the same menu. The old token stops working straight away.

Home-server projects without an address are always private. Request bodies can be up to 10 MB, your app has 100 seconds to start answering, and WebSockets aren't relayed yet.

Limits

.vibepuppy.app addresses2 per account
Home servers1 public and 3 private per account. Private ones are on .codepuppy.online and don't use your free addresses
Time to verify a new name24 hours
Guest email linksWork once, for 30 minutes

CodepuppyIO is free while it's in public beta, and features may change.

Questions

Does my address get HTTPS?
Yes. Every address is served over HTTPS automatically.
Can my app set cookies?
No. Cookies set by your app are dropped, so that one site can't set cookies for its neighbours. Keep sign-in state in your app's JavaScript, for example as a token in local storage.
How do I change where my address points?
Edit the project and change its URL. You'll verify again with a new key, since the file has to be on the new site.
How do I give up an address?
Delete the project. The address stops working straight away and anyone can claim it. This can't be undone.
What's the picture on my project card?
A snapshot of your site, taken by CodepuppyIO. Use Update snapshots on the Projects page to refresh it after you change your site.

Back to CodepuppyIO · Terms of Service