Getting Started Guide

86 vues Markdown

The checklist a new installation works through: everything that still has to be configured before you can take an order, read from the system rather than ticked by hand.

Reaching the Screen

Panel menu: Help then Getting Started: {admin}/help/getting-started

It is the first entry of that menu on purpose, and it stays there forever. While a required step is still open the dashboard also carries a reminder strip, though only for staff who can change settings, and its button does not always lead here. The dashboard reminder below has the conditions.

What Is on the Screen

Two columns: the work on the left, the state of it on the right. Below 1200px the state panel moves above the list, so the headline is read before the checklist.

The step list One card holding every setup step, one row each. The rows are a dependency chain, not a preference list: an order that cannot be paid for or confirmed by e-mail is not a sale.

Required and Recommended Two headings inside the same card. Required is what stands between you and a first sale; Recommended is what keeps service setup from staying manual. Once every step is done the required list is replaced by a single confirmation panel, and only the recommended list remains.

The state panel The right column, headed Setup: one headline sentence, one supporting line, a progress bar and the two links at the bottom. It follows the list down the page so the headline does not scroll away while you work.

A step row

Every row is the same shape: a marker, the step name, and its state on the right. The badge is where the state is spelled out; the marker and the name follow it, and the one open step also sits on a faint tint so it can be found without reading.

A done step Tick marker, softened name, and a green badge carrying the reading behind the verdict (how many products are on sale, which mail driver is active).

The next step The first open step, and the only row that opens up: a faint tinted background, arrow marker, a Next badge, a sentence saying what breaks while it is undone, and the button that goes to the screen where it is configured. Exactly one row is ever in this state.

A waiting step Empty marker and a neutral badge with its current reading. No reason and no button: they belong to the step you are on, not to the ones behind it.

The button of the open step opens its target in a new tab. The guide is a map, and a map you have to navigate away from stops being one.

The state panel

The headline is the page in one sentence and it counts required steps only, because a recommended step never blocks selling. It reads as the number of steps left, then as "You are ready to sell" once the required ones are gone, and finally as "Setup is complete" when nothing at all is left. The line under it gives the same figure the long way round, and the bar below is the picture of that sentence. Both the bar and the Reopen the Wizard button disappear once setup is complete.

The footer carries one reminder and one link. PHP version, file permissions and cache are not configured from this guide; their state is reported on the health page, which the Open Health Status link opens.

The dashboard reminder

The same state appears on the dashboard as a strip while a required step is open: the count, the name of the next step, a segmented meter, a button and a close control. The button is Continue Setup when the welcome window is available on that page, and Open the Guide otherwise.

The strip is a nudge, not a fixture. It goes away by itself when the last required step lands, and the close control hides it for a week. What that actually stores is worth knowing, so it is spelled out under Things to Watch below.

Fields

Every step answers "is this actually configured?" by reading the system. The label is the step name as it appears in the list; the sentence says when it counts as done.

Source File Protection Required. Done while the last web exposure measurement found nothing downloadable. The installation fetches one of its own template files from its public address, and the file must be refused. The verdict is the one Help → Health Status and the daily security check store. An installation nothing has measured yet is probed once, with two requests, when the guide is first built. When the site cannot reach its own address the step is left out rather than shown with an unearned verdict. Open Health Status for the list of exposed paths and the fix for your server: on nginx the DENY section of nginx.conf.example, on Apache the package's .htaccess files being read.

Scheduled Tasks Required. Done while the last tick of the scheduled worker is less than ten minutes old. Until the worker has run at all the badge reads "Has never run", which is what a fresh installation shows; after the first tick it reports the gap, so a worker that stopped an hour ago still shows when it last ran while the step goes back to open. Invoicing, renewal reminders and suspending overdue services all run through it.

Outgoing Email Required. Done when a mail driver other than the sandbox one is selected. The sandbox driver writes every message to disk and nothing leaves the server, so order confirmations, invoices and password resets are never delivered until a real driver is configured.

Payment Method Required. Done when at least one payment method is switched on, account balance aside: balance charges an internal wallet, so it cannot be the only way money arrives. The badge counts the methods that qualify.

First Product Required. Done when at least one product is on sale, meaning its status is active. Drafts and disabled products are not counted.

Contracts Required. Done when at least one contract page is published, meaning its status is active. The order form links these as the terms the client accepts. With none published it has nothing to link, and the purchase completes without any agreement.

Tax Settings Recommended. Done when tax is switched on, and the badge then names the model in use: tax included or tax excluded. With tax off every invoice is issued without it, and if you are required to charge it the totals are short.

Service Server Recommended, and listed only when the installation sells hosting or servers. Done when at least one server is defined, whatever state that server is in. Without one, hosting services are not provisioned automatically and every order is opened by hand.

Domain Registrar Recommended, and listed only when the installation sells domains. Done when at least one extension points at a registrar module instead of none. Without one, registration and renewal are not handled automatically.

The last two are the only conditional rows. They follow the product groups the installation sells, which are switched in advanced settings and asked for once in the welcome window: a step for something you do not sell is not pending, it is irrelevant, so it is not listed at all.

Tasks

Work through the next step

Find the row carrying the Next badge. It is the only one that says why it matters and the only one with a button.
Use its button. The screen it needs opens in a new tab, so the guide stays where it is.
Configure it there, then come back to the guide tab and reload the page.
The row turns into a done one and the Next badge moves to the first step still open, skipping any that are already done. While required steps remain, the headline drops by one.

Reopen the welcome window

Use Reopen the Wizard at the bottom of the state panel. It is shown only while setup is incomplete.
The dashboard opens with the window on it, walking past the marker that normally limits it to one appearance.
Work through its panes or close it. Either way the guide is unaffected, and the steps it can fill in are marked done the next time this page is loaded.

Hide the dashboard reminder

Go to the dashboard and use the close control at the end of the reminder strip.
The strip folds away at once and stays off the dashboard for a week.
The guide is untouched: the Help menu entry and this page stay exactly where they were.

Things to Watch

Hiding is a browser preference, not a setting

The close control on the dashboard strip writes a cookie that lasts seven days, in that browser only. Another member of staff, another browser or cleared browsing data all bring the strip straight back, and nothing about the setup state changes. It is deliberately not stored with the shared settings: one admin waving the reminder off would otherwise hide it for everyone.

The welcome window greets an installation once

Its marker is kept in the database, not in a cookie, and it is written the moment the window is shown. So a second member of staff never lands in a settings wizard on a live installation, and clearing cookies does not bring it back. An installation that already has client accounts is never greeted at all. Reopen the Wizard is the way back to it.

Nothing here is ticked by hand

Each step asks the system whether the thing is really configured, so a step can go back to open on its own. If the scheduled worker stops, the first step reopens, the headline goes up by one and the reminder returns to the dashboard. There is no way to mark a step done without doing it.

Required Privileges

The page opens for staff who can reach the Help menu at all, which means holding any of HELP_HEALTH, HELP_UPDATES_LOOK, HELP_UPDATES_OPERATION, HELP_LICENSE or HELP_USE_GUIDE. The guide asks for nothing beyond that, because it only reads.

The dashboard reminder and the welcome window ask for more: any privilege in the settings group, or ADMIN_PRIVILEGES. Reminding someone of work they have no permission to do is noise, so staff without it simply never see them.

Each step's button leads to a screen with its own privileges. The Open Health Status link is shown to everyone who can open this page; the health page behind it is the part that asks for HELP_HEALTH and refuses to open without it.

Cet article vous a-t-il été utile ?

Merci pour votre retour !

Besoin d'aide supplémentaire ?

Notre équipe d'assistance est disponible 24h/24 pour tout ce que vous ne trouvez pas ci-dessus.

Nous contacter Ouvrir un ticket