Hosting with 20% off when you buy through the link

Install Velk

One request installs the engine, creates the database and your admin user. What Velk needs, what the AI asks and does, and how to open the site on your computer.

Installing Velk puts the engine in a folder on your computer and creates its database and your admin user. With the skill, it's one request. Velk needs no Composer and no build step: PHP and a MySQL database are enough. Build on your computer first, check it, and publish later.

What Velk needs

PieceRequirement
PHP8.2 or newer, with the extensions pdo_mysql, gd, fileinfo and mbstring.
DatabaseMySQL 5.7 or newer, or MariaDB 10.3 or newer.
Web serverOn your computer, Velk's own development server. On the hosting, Apache with mod_rewrite, or Nginx.

Ask the AI

I need PHP 8.2 or newer and MySQL running on this computer to work with Velk. Check what's already installed and install what's missing.

On a Mac the AI uses Homebrew. On Windows it guides you through XAMPP, a graphical installer with PHP and MySQL; there, the clicks are yours.

What the AI runs on a Mac
$ brew install php mysql $ brew services start mysql # checking the versions $ php -v $ mysql --version
If PHP shows 8.1 or older, ask for an update before going on.

Ask the AI

Install Velk here. The site is called Harbor Dental. Use the local MySQL (user root, no password) and create a database called harbor_dental.

Open an empty folder first. The AI asks what it can't guess and shows each step as it runs.

What it asks

QuestionWhat to answer
Database accessThe user and password of your local MySQL. On a new setup it's usually root with no password. The AI creates the database; it only needs a way in.
Database nameAny name, such as harbor_dental. It's created if it doesn't exist.
Your admin loginEmail, password (at least 8 characters) and name. This is how you sign in to the panel.
Site address (APP_URL)Leave it blank on your computer: Velk detects it. The real address goes in when you publish.
Email sending (SMTP)Optional, and it can wait. Until it's set, the site may not send emails such as form notifications.

What it does

  1. Checks the folder

    If Velk is already there, it stops and asks whether to reinstall, update or only apply what's pending. It never touches an existing .env without asking.

  2. Downloads the official release

    The latest version from releases.velkcms.com, checked against its published fingerprint (sha256) before anything is unpacked. If they differ, the install stops.

  3. Writes .env

    The file with the database password and this copy's settings, readable only by your user.

  4. Runs the installer

    bin/velk install creates the database if needed, applies the migrations (the database changes each version brings), creates your admin user and puts .htaccess and robots.txt in place.

  5. Cleans up and records the version

    It removes the setup files that have no further use and writes .velk-version, so later updates know what's installed.

What the AI runs
# the list of versions, each with its fingerprint $ curl -fsSL https://releases.velkcms.com/versions.json # download, check the fingerprint, unpack $ curl -fSL https://releases.velkcms.com/velk-latest.tar.gz -o velk.tar.gz $ shasum -a 256 velk.tar.gz $ tar -xzf velk.tar.gz && cp -a velk-v*/. ./ # database, tables and your admin user $ ./bin/velk install ✓ Installed.
Shown for reference: you don't type any of it.

See it running

Velk brings a development server. Ask “start the site on my computer” and the AI runs bin/velk serve: the site answers at http://localhost:8080 and the panel at http://localhost:8080/admin, where you sign in with the email and password you chose. The site is up while that server runs. If another program already uses port 8080, ask for a different one; the command takes the number, as in bin/velk serve 8081.

The install stopped with a connection error.

MySQL is probably not running. On a Mac the AI runs brew services start mysql; on Windows, start MySQL in the XAMPP control panel. Then ask it to try again: it picks up where it stopped.

The AI says Homebrew needs my Mac's password.

When a Mac doesn't have Homebrew yet, its installer asks for the Mac's password, which only you can type, in the Terminal app. The AI gives you the command to paste there.

Which PHP version should I use?

8.2 or newer. If you already know the hosting, match its version: code that runs on a newer PHP can fail on an older one.

Can I install by hand?

Yes. The manual steps (the .env, bin/velk install and the web server rules) are on the Documentation page.