You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/en/self-host-installation.md
+44-30Lines changed: 44 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -50,47 +50,58 @@ Invoice Ninja does not support installation into a subdirectory. You will need a
50
50
51
51
## Installing Invoice Ninja
52
52
53
-
### Ubuntu 20.04 (Recommended)
53
+
### CLI script
54
+
55
+
If your webserver is already configured and you have credentials to your database, community member Dros has created a CLI management and maintenance script for you.
*This script complements the excellent [Distribution based server configurations](#distribution-based-server-configurations) below. Once your server meets the prerequisites (webserver configured & database accessible), this script makes the rest of the setup a breeze.*
60
+
61
+
### Docker
62
+
63
+
We have a dedicated repository with detailed instructions on how to get started <ahref="https://github.com/invoiceninja/dockerfiles">HERE</a>.
If you make changes to your env file, please remember to reboot the container for the changes to take effect!
69
+
</x-warning>
70
+
71
+
### Distribution based server configurations
72
+
73
+
If you need to configure your server from scratch, you'll find some excellent tutorials below.
74
+
75
+
#### Ubuntu 20.04 (Recommended)
54
76
55
77
Community member TechnicallyComputers has a very helpful step by step guide on how to install Invoice Ninja v5 from scratch onto Ubuntu, you can access the guide [here](https://forum.invoiceninja.com/t/install-invoice-ninja-v5-on-ubuntu-20-04/4588)
56
78
57
-
### Ubuntu 22.04
79
+
####Ubuntu 22.04
58
80
59
81
Community member TechnicallyComputers has a very helpful step by step guide on how to install Invoice Ninja v5.5 from scratch onto Ubuntu, you can access the guide [here](https://forum.invoiceninja.com/t/install-invoice-ninja-v5-5-on-ubuntu-22-04/13272)
60
82
61
-
### Installing on CentOS 8
83
+
####Installing on CentOS 8
62
84
63
85
If CentOS is more your Flavour, community member TechnicallyComputers has a very thorough step by step installation guide [here](https://forum.invoiceninja.com/t/install-invoice-ninja-v5-on-centos-8/4293).
64
86
65
-
### Installing on Arch
87
+
####Installing on Arch
66
88
67
89
If Arch Linux is more your flavour, community member brackenhill-mob has a very thorough step by step installation guide [here](https://forum.invoiceninja.com/t/howto-install-invoice-ninja-v5-on-arch-linux/6196)
68
90
69
-
### Installing on Enterprise Linux
91
+
####Installing on Enterprise Linux
70
92
71
93
TechnicallyComputers also has a guide for installation Invoice Ninja on Enterprise Linux [here](https://forum.invoiceninja.com/t/install-invoice-ninja-v5-on-enterprise-linux-8/4293)
72
94
73
-
### Installing using Docker
74
95
75
-
We have a dedicated repository with detailed instructions on how to get started <ahref="https://github.com/invoiceninja/dockerfiles">HERE</a>.
<p>A prebuilt archive can be downloaded from our GitHub release page <ahref="https://github.com/invoiceninja/invoiceninja/releases">here</a>. You will need to download the package named <b>invoiceninja.tar</b></p>
100
+
A prebuilt archive can be downloaded from our GitHub release page [here](https://github.com/invoiceninja/invoiceninja/releases). You will need to download the package named **invoiceninja.tar**
88
101
89
102
<p>Unpack this file into the virtual host directory you have created.</p>
90
103
91
-
<x-warning>
92
-
Please note the release file invoiceninja.tar excludes the .htaccess file, this archive is solely designed for our self host auto updater.
93
-
</x-warning>
104
+
This option is suited for advanced users. If you prefer a more convenient installation option, consider the [CLI script](#cli-script).
<p>A sample NGINX configuration is provided below, it assumes you have PHP 8.1 installed with the PHP FPM extension installed</p>
108
119
109
120
```bash
@@ -153,41 +164,43 @@ Performance hint!
153
164
Enable gzip in your webserver configuration, this will dramatically improve the loading time of the application! Please see the above nginx configuration for a sample of how to load the components of the application with gzip.
154
165
</x-warning>
155
166
156
-
##### Database server configuration
167
+
#### Database server configuration
157
168
158
169
<p>Create a database on your MySQL compatible server and add a user that has full access to the database. Database configuration is out of the scope of this article, more information can be found <a href="https://dev.mysql.com/doc/refman/8.0/en/creating-database.html">here</a></p>
159
170
160
-
##### Cron configuration
171
+
#### Cron configuration
161
172
162
173
<x-warning>
163
174
Ensure you set the scheduler under the web server user i.e. `sudo -u www-data crontab -e`
164
175
</x-warning>
165
176
166
-
<p>Invoice Ninja relies heavily on the Laravel Scheduler, for this to operate it requires that a cron job to be configured, edit your crontab and enter the following record.</p>
177
+
Invoice Ninja relies heavily on the Laravel Scheduler, for this to operate it requires that a cron job to be configured, edit your crontab and enter the following record.
*Be aware, at the time of writing the react frontend is not included by default if you clone this repository. Refer to the configured Github workflow for additional information.*
200
+
188
201
### Final setup steps
189
202
190
-
<p>Once you have configured your virtual host, copy the same .env file</p>
203
+
Once you have configured your virtual host, copy the same .env file
191
204
192
205
193
206
```bash
@@ -200,12 +213,13 @@ to
200
213
.env
201
214
202
215
```
203
-
<p>
204
-
then create a database and point your browser to http://your.domain.com/setup - the setup process will check a number of system settings such as PDF generation, database and mail settings and also allow you to configure the first account on the system, click Submit and the app will setup your application and redirect you to the login page</p>
216
+
217
+
then create a database and point your browser to http://your.domain.com/setup - the setup process will check a number of system settings such as PDF generation, database and mail settings and also allow you to configure the first account on the system, click Submit and the app will setup your application and redirect you to the login page
205
218
206
219
207
220
#### Cron configuration
208
-
<p>Invoice Ninja relies heavily on the Laravel Scheduler, for this to operate it requires that a cron job to be configured, edit your crontab and enter the following record</p>
221
+
222
+
Invoice Ninja relies heavily on the Laravel Scheduler, for this to operate it requires that a cron job to be configured, edit your crontab and enter the following record
209
223
210
224
<x-warning>
211
225
Ensure you set the scheduler under the web server user i.e. `sudo -u www-data crontab -e`
0 commit comments