Improve installation docs

This commit is contained in:
2026-02-25 15:07:27 +01:00
parent 5f94e330ad
commit 8ff955415c
+42 -8
View File
@@ -37,33 +37,67 @@ ### Prerequisites
- Node.js (for frontend assets)
- SQLite/MySQL/PostgreSQL
### Apache config
```apache
<VirtualHost *:80>
ServerName crm.tooloop.de
Redirect permanent / https://crm.tooloop.de/
</VirtualHost>
<VirtualHost *:443>
ServerName crm.tooloop.de
DocumentRoot /var/www/html/caramel/public/
SSLEngine on
SSLCertificateFile /etc/letsencrypt/live/cloud.tooloop.de/fullchain.pem
SSLCertificateKeyFile /etc/letsencrypt/live/cloud.tooloop.de/privkey.pem
Include /etc/letsencrypt/options-ssl-apache.conf
<Directory /var/www/html/caramel/public>
Options -Indexes +FollowSymLinks
AllowOverride All
Require all granted
</Directory>
ErrorLog ${APACHE_LOG_DIR}/caramel_error.log
CustomLog ${APACHE_LOG_DIR}/caramel-access.log combined
</VirtualHost>
```
### Steps
1. Clone the repository:
```bash
git clone http://code.tooloop.de/Tooloop/Caramel-CRM.git
git clone http://code.tooloop.de/Tooloop/Caramel-CRM.**git**
cd Caramel-CRM
```
2. Create empty database:
```bash
touch database/database.sqlite
```
3. Set permissions
```bash
sudo chown -R www-data:www-data /var/www/html/caramel/storage/ bootstrap/cache/
sudo chmod g+rw /var/www/html/caramel/storage/ /var/www/html/caramel/bootstrap/cache/
```
3. Install dependencies:
```bash
composer update
composer install
npm install
```
4. Set up the environment:
```bash
cp .env.example .env
php artisan key\:generate
sudo php artisan key\:generate
```
5. Run migrations and seeders:
```bash
php artisan migrate --seed
sudo php artisan migrate --seed
```
6. Build frontend assets:
```bash
npm run dev
npm run build
```
7. Start the development server:
```bash
@@ -82,10 +116,10 @@ ### Running the scheduler
You can choose between one of three updating methods by editing the `app.cron_method` value in the database table `settings`:
| Value | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `cron` | If you can, configure a CRON job in the OS |
| `webcron` | Some hosting prividers provide a feature to call a HTTP-request in regular intervals. |
| Value | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cron` | If you can, configure a CRON job in the OS |
| `webcron` | Some hosting prividers provide a feature to call a HTTP-request in regular intervals. |
| `request` | If both of the above are not possible in your setup, you can choose `request`. The web UI will then regularly call the `/webcron` route from your browser. |