Skip to content

manual install: add cron and storage doc steps #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OniriCorpe wants to merge 2 commits into
base: master
Choose a base branch
from
Open

manual install: add cron and storage doc steps #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
190deee
manual install: add cron and storage doc steps
OniriCorpe Nov 29, 2024
8188293
typo
OniriCorpe Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions docs/install/manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ XML PHP Extension
ZIP PHP Extension
```

## Step 1 : Download
## Step 1: Download

[Download](http://invoiceshelf.com/) the latest InvoiceShelf package.

Alternatively, If you are a developer, follow the instructions to setup development environment on [this Link](../developer-guide.md)

## Step 2 : Upload to Server
## Step 2: Upload to Server

Upload the downloaded zip file to your Server and unzip it, you should see the InvoiceShelf folder.

## Step 3 : Point the domain to the uploaded folder
## Step 3: Point the domain to the uploaded folder

Point your domain or subdomain to the `public` directory inside the InvoiceShelf folder.

Expand Down Expand Up @@ -67,7 +67,23 @@ chown -R www-data:www-data storage
chown -R www-data:www-data bootstrap/cache
```

## Step 4 : Copy Environment File
## Step 4: Add cron file

Create a new cron file as `/etc/cron.d/invoiceshelf` with the following line:

```cron
* * * * * /usr/bin/php /path/to/your/install/artisan schedule:run >> /dev/null 2>&1
```
Comment on lines +72 to +76
Copy link
Copy Markdown
Contributor

@fritzmg fritzmg Apr 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will only work in Debian derivatives, correct? In other systems /etc/cron.d/ contains shell scripts. Why not just use crontab -e?


## Step 5: Link the storage directory

For media (images, PDFs...) to function properly, you must initialize the link to the storage folder using this command:

```sh
php artisan storage:link
```

## Step 6: Copy Environment File

1. Locate the Example File: In the root directory of your project, find the file named `.env.example`.
2. Copy the `.env.example` file and create a new file named `.env` in the same root directory.
Expand All @@ -83,11 +99,10 @@ php artisan key:generate

or generate it manually on the [following link](https://generate-random.org/laravel-key-generator).


By following these steps, you will create a new `.env` file that can be customized with your environment-specific settings.

> For example, you can change the default SQLite database to MySQL or PostgreSQL.

## Step 5 : Complete installation wizard
## Step 7: Complete installation wizard

Open the link to the domain in the browser (Example: `https://demo.invoiceshelf.com`) and complete the installation wizard as directed.