mirror of
https://codeberg.org/vegvisir/website.git
synced 2025-09-14 00:43:42 +02:00
50 lines
No EOL
2.2 KiB
PHP
50 lines
No EOL
2.2 KiB
PHP
<?php
|
|
|
|
use const VVWebsite\{MEDIA_DIR, DEFAULT_BUTTON_ICON};
|
|
|
|
require_once VV::root("src/Consts.php");
|
|
|
|
?>
|
|
<?= VV::include("public/docs/v3.1.4/layout") ?>
|
|
<main>
|
|
<section class="md">
|
|
<h1>Get Started with Vegvisir</h1>
|
|
<p>In this guide we will install Vegvisir from a template repository. I will be using a Debian Linux environment for this demonstration.</p>
|
|
</section>
|
|
<section class="md">
|
|
<h2>Prerequisites</h2>
|
|
<ul>
|
|
<li>PHP 8.3+</li>
|
|
<li>Composer</li>
|
|
<li>A web server</li>
|
|
</ul>
|
|
</section>
|
|
<section class="md">
|
|
<h2>1. Clone the template repository</h2>
|
|
<p>There is a template repository on Codeberg which you can clone or generate from which has a bare-bones website ready for us.</p>
|
|
<a href="https://codeberg.org/vegvisir/template" target="_blank"><button class="inline">
|
|
<p>Template repository</p>
|
|
<?= VV::embed(DEFAULT_BUTTON_ICON) ?>
|
|
</button></a>
|
|
</section>
|
|
<section class="md">
|
|
<h2>2. Run the install script</h2>
|
|
<p>The template repository has an <code>install.sh</code> file in its root directory which will install and set up our Vegvisir configuration for us.</p>
|
|
<?= VV::include("snippets/HTMLCodeDemoElement/HTMLCodeDemoElement?id=docs/v3.1.4/get-started/run_install_script") ?>
|
|
</section>
|
|
<section class="md">
|
|
<h2>3. Configure your webserver</h2>
|
|
<p>In this demo we will be using <strong>NGINX</strong> as our web server, and <a href="https://packages.sury.org/php/"><strong>PHP-FPM</strong></a> (packaged by Ondřej Surý) as our FastCGI processor.</p>
|
|
<p>As long as you point <strong>all traffic</strong> to <code>/vegvisir/public/index.php</code> with PHP pass you should be fine with other web server programs too.</p>
|
|
<?= VV::include("snippets/HTMLCodeDemoElement/HTMLCodeDemoElement?id=docs/v3.1.4/get-started/nginx") ?>
|
|
</section>
|
|
<section class="md">
|
|
<h2>4. Done!</h2>
|
|
<p>Navigate to your configured web server host and if you're greeted with a welcome to Vegvisir page, then everything is working as it should!</p>
|
|
<p>Feel free to experiment or follow the reference guide for more information about each Vegvisir feature.</p>
|
|
<a href="/docs/Reference"><button class="inline">
|
|
<p>Reference guide</p>
|
|
<?= VV::embed(DEFAULT_BUTTON_ICON) ?>
|
|
</button></a>
|
|
</section>
|
|
</main>
|