getkirby / getkirby.com

Source code and content for the Kirby website
https://getkirby.com
134 stars 271 forks source link

Improve first installation instructions #2381

Open philgyford opened 1 week ago

philgyford commented 1 week ago

After playing with the Starterkit and reading the documentation I downloaded the Plainkit but it took me a while to get anything working. I'm running it locally, using a Docker container (rather than install PHP on my own Mac).

The Installing Kirby instructions say to download and extract the zip file, and visit the Panel at yourdomain.com/panel. But that displayed this error:

Screenshot 2024-11-14 at 16 53 50

First, I'm not on a "public server" and second, this message gives me no indication of what to do.

After googling and reading I eventually realised I also needed to:

  1. Create a file at site/config/config.php (creating the site/config/ directory)
  2. Make the contents of that file:

    <?php
    
    return [
        'panel' => [
            'install' => true
        ]
    ];

From reading the forum it sounds like maybe there used to be some indication of this in the docs (see this comment), but I can't see anything about this in the Quickstart or Installation pages.

texnixe commented 1 week ago

Hm, that information is in an info box in the quick start guide if you scroll down a bit to the "Create your first account" section: https://getkirby.com/docs/guide/quickstart#create-your-first-account

For security reasons, you cannot install the Panel on a public server by default. To allow this, you can enable the panel.install option:

philgyford commented 1 week ago

Thanks @texnixe.

I missed that because the installation instructions say "Visit the Panel at yourdomain.com/panel" and then show a picture of the panel. There are no other steps or suggestions at that point as to what to do if you get an error instead. There didn't seem any point with "Create your first account" if I couldn't access the panel.

Also, I'm not using a "public" or "remote" server.

Also, could the error message itself link to the relevant part of the documentation?

This feels like one of those things that's blindingly obvious to anyone familiar with Kirby, but a baffling dead end if you're not.

texnixe commented 1 week ago

Also, could the error message itself link to the relevant part of the documentation? That's an idea.

I updated the page to link directly to that "create account" section from the installation instruction to make it a bit clearer.

However, I wonder why your Docker installation is regarded as a remote server. Guess you are not running it under localhost, then?

philgyford commented 1 week ago

I'm visiting the site at http://127.0.0.1:8000