Skip to content

Commit 5062430

Browse files
jbrooksukjbrooksuk
committed
Update installation docs
1 parent b09eec5 commit 5062430

File tree

1 file changed

+75
-71
lines changed

1 file changed

+75
-71
lines changed

‎v3.x/installation.mdx‎

Lines changed: 75 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -20,74 +20,78 @@ Cachet v3.x is written in PHP with Laravel 11.x and requires:
2020

2121
If you are looking to migrate from Cachet v2.x, please refer to the [migration guide](/v3.x/migration-guide).
2222

23-
<Steps>
24-
<Step title="Step 1">
25-
Clone the Cachet repository:
26-
```bash
27-
git clone -b 3.x https://github.com/cachethq/cachet.git
28-
cd cachet
29-
```
30-
</Step>
31-
<Step title="Step 2">
32-
Install the dependencies:
33-
```bash
34-
composer install --no-dev -o
35-
```
36-
</Step>
37-
<Step title="Step 3">
38-
Update the `cachethq/core` dependency:
39-
```bash
40-
composer update cachethq/core
41-
```
42-
<Note>
43-
This is a temporary step until Cachet v3.x is released.
44-
</Note>
45-
</Step>
46-
<Step title="Step 4">
47-
Copy the `.env.example` file to `.env`:
48-
```bash
49-
cp .env.example .env
50-
```
51-
</Step>
52-
<Step title="Step 5">
53-
Generate an application key:
54-
```bash
55-
php artisan key:generate
56-
```
57-
</Step>
58-
<Step title="Step 6">
59-
Configure the `.env` file and set the values of your setup:
60-
```ini .env
61-
DB_CONNECTION=mysql
62-
DB_HOST=127.0.0.1
63-
DB_PORT=3306
64-
DB_DATABASE=cachet
65-
DB_USERNAME=root
66-
DB_PASSWORD=
67-
```
68-
</Step>
69-
<Step title="Step 7">
70-
Publish Cachet's assets:
71-
```bash
72-
php artisan vendor:publish --tag=cachet
73-
```
74-
</Step>
75-
<Step title="Step 8">
76-
Run the database migrations:
77-
```bash
78-
php artisan migrate
79-
```
80-
</Step>
81-
<Step title="Step 9">
82-
Create the first user by following the prompts:
83-
```bash
84-
php artisan cachet:make:user
85-
```
86-
</Step>
87-
<Step title="Step 10">
88-
Enable the scheduler by adding the following cron entry:
89-
```bash /etc/crontab
90-
* * * * * php /path/to/cachet/artisan schedule:run >> /dev/null 2>&1
91-
```
92-
</Step>
93-
</Steps>
23+
<Tabs>
24+
<Tab title="Manual Setup">
25+
<Steps>
26+
<Step title="Step 1">
27+
Clone the Cachet repository:
28+
```bash
29+
git clone -b 3.x https://github.com/cachethq/cachet.git
30+
cd cachet
31+
```
32+
</Step>
33+
<Step title="Step 2">
34+
Install the dependencies:
35+
```bash
36+
composer install --no-dev -o
37+
```
38+
</Step>
39+
<Step title="Step 3">
40+
Update the `cachethq/core` dependency:
41+
```bash
42+
composer update cachethq/core
43+
```
44+
<Note>
45+
This is a temporary step until Cachet v3.x is released.
46+
</Note>
47+
</Step>
48+
<Step title="Step 4">
49+
Copy the `.env.example` file to `.env`:
50+
```bash
51+
cp .env.example .env
52+
```
53+
</Step>
54+
<Step title="Step 5">
55+
Generate an application key:
56+
```bash
57+
php artisan key:generate
58+
```
59+
</Step>
60+
<Step title="Step 6">
61+
Configure the `.env` file and set the values of your setup:
62+
```ini .env
63+
DB_CONNECTION=mysql
64+
DB_HOST=127.0.0.1
65+
DB_PORT=3306
66+
DB_DATABASE=cachet
67+
DB_USERNAME=root
68+
DB_PASSWORD=
69+
```
70+
</Step>
71+
<Step title="Step 7">
72+
Publish Cachet's assets:
73+
```bash
74+
php artisan vendor:publish --tag=cachet
75+
```
76+
</Step>
77+
<Step title="Step 8">
78+
Run the database migrations:
79+
```bash
80+
php artisan migrate
81+
```
82+
</Step>
83+
<Step title="Step 9">
84+
Create the first user by following the prompts:
85+
```bash
86+
php artisan cachet:make:user
87+
```
88+
</Step>
89+
<Step title="Step 10">
90+
Enable the scheduler by adding the following cron entry:
91+
```bash /etc/crontab
92+
* * * * * php /path/to/cachet/artisan schedule:run >> /dev/null 2>&1
93+
```
94+
</Step>
95+
</Steps>
96+
</Tab>
97+
</Tabs>

0 commit comments

Comments
 (0)