Tinkerwell 5: Welcome to the AI age
See what's new
Tinkerwell background image
Tinkerwell Logo Tinkerwell

Documentation

Laravel Forge
#

Tinkerwell can import all sites from your Laravel Forge account as SSH connections, so you don't have to set up every server by hand.

To get started, create an API token in the API section of your Forge account settings. Then, paste the token in Settings → Integrations → Laravel Forge. Tinkerwell will automatically load your servers and sites. Click Update next to Sites & Servers whenever you add new sites in Forge.

API token scopes
#

Tinkerwell only reads your servers and sites, so the token needs a single scope:

  • server:view

If the scope is missing, Tinkerwell shows an error and doesn't import anything.

If you connected Forge before the API was redesigned, your existing token still works — you don't need to issue a new one. Just open the token in the Forge dashboard and add the server:view scope.

Imported connections
#

Every server becomes a connection group in the SSH connection window, with one connection per site. Tinkerwell imports PHP sites that are fully installed. Static HTML, Next.js, Nuxt.js and Minecraft sites are skipped.

Each connection is created with these defaults:

Setting Value
Host and port The IP address and SSH port of the server
Username The site user, e.g. forge
Authentication SSH key at ~/.ssh/id_rsa
Application folder /home/<user>/<site>
PHP binary php

Tinkerwell doesn't upload an SSH key for you. Make sure the key on your machine is added to the server in Forge, or edit the connection to use a different key.

Updating again only adds new sites. Connections you already imported, including any changes you made to them, stay untouched.