Skip to content

Commit

Permalink
added warning snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinpapst committed Aug 8, 2024
1 parent 9b06375 commit 92ad680
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 16 deletions.
4 changes: 2 additions & 2 deletions _documentation/fresh-ubuntu-20.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ This documentation is outdated.
Please upgrade and use <a href="{% link _documentation/fresh-ubuntu-22.md %}">Ubuntu 22.04 LTS</a> instead.
{% endalert %}

{% include snippets/self-hosting-warning.md %}

This is a collection of snippets to help you with setting up a fresh Ubuntu 20.04 server for using with Kimai.
It is neither a fully fledged documentation, explaining each step, nor is it a bash tutorial.

{% include snippets/self-hosting-warning.md %}

Please see it as a personal snippet collection... in which I assume:
- that you are familiar with the Linux bash and have at least basic knowledge of vim
- that you use a single domain on this server, change the nginx configuration accordingly if you have multiple VirtualHosts
Expand Down
4 changes: 2 additions & 2 deletions _documentation/fresh-ubuntu-22.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ related:
- fresh-ubuntu-20
---

{% include snippets/self-hosting-warning.md %}

This is a collection of snippets to help you with setting up a fresh Ubuntu 22.04 LTS server for using with Kimai.
It is neither a fully fledged documentation, explaining each step, nor is it a bash tutorial.

{% include snippets/self-hosting-warning.md %}

Please see it as a personal snippet collection... in which I assume:
- that you are familiar with the Linux bash and have at least basic knowledge of vim
- that you use a single domain on this server, change the nginx configuration accordingly if you have multiple VirtualHosts
Expand Down
7 changes: 5 additions & 2 deletions _documentation/hosting-1-click.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ description: Kimai can be hosted on various systems and many hosting companies s
canonical: /documentation/hosting-1-click.html
---

{% include snippets/unsupported-installation-warning.md %}
{% include snippets/self-hosting-warning.md %}

The following platforms adopted Kimai to be compatible with their one-click installation systems.

### YunoHost
Expand Down Expand Up @@ -38,13 +41,13 @@ You don't have to worry about updates as Elestio auto updates Kimai instance wee
### Softaculous

Be warned that Softaculous **does not yet provide updates of Kimai**, so you are stuck with the installed version.
There have been a few other problems reported, using this installation type is not advised for production usage.
There have been a few other problems reported, using this installation type is ONLY FOR EVALUATION usage.

[Install Kimai with Softaculous](https://www.softaculous.com/apps/others/Kimai){: .btn .btn-success}

### Vesta Control Panel

Be aware that VestaCP uses the `admin` user instead of `www-data`. Replace the names in the regular permission commandss.
Be aware that VestaCP uses the `admin` user instead of `www-data`. Replace the names in the regular permission commands.
Read [this issue]({{ site.kimai_v2_repo }}/issues/743) if you have further questions.

### ISPConfig 3
Expand Down
7 changes: 2 additions & 5 deletions _documentation/shared-hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ description: How to install Kimai in a shared hosting environment
canonical: /documentation/shared-hosting.html
---

## Shared hosting

How to install Kimai at shared hosting companies. Please share our insights if you have managed to get it up and running with another company!

If you can't find the correct version, ask your hoster! Or [let us help you]({% link _store/keleo-installation-support.md %}).
{% include snippets/unsupported-installation-warning.md %}
{% include snippets/self-hosting-warning.md %}

### Uberspace

Expand Down
9 changes: 5 additions & 4 deletions _documentation/synology.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ description: "How to install Kimai on a Synology NAS with DSM 7+"
canonical: /documentation/synology.html
---

This HowTo does not explain every step for the installation of Kimai on a Synology NAS with **DSM 7+**.
{% include snippets/unsupported-installation-warning.md %}
{% include snippets/self-hosting-warning.md %}

If someone can contribute and write down a step-by-step guide, that would be 🔥

Everything is handled via the `Conatiner Manager` on the DSM Web UI.
Everything is handled via the `Conatiner Manager` on the Synology DSM 7+ Web UI.

This HowTo explains the installation of Kimai on a Synology NAS with **DSM 7+** - but right now there are some steps missing.

## Installation

- Open "Container Manager"
Expand Down
2 changes: 2 additions & 0 deletions _documentation/webserver-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ navigation: Webserver
description: How to install Kimai on your server with git, composer and SSH or FTP
---

{% include snippets/self-hosting-warning.md %}

If you can't manage to get Kimai up and running, it is very likely not an issue with Kimai.
- Check your server logs first and the Kimai logs (at `var/logs/` inside the Kimai directory).
- Try to find an answer at Stackoverflow, ServerFault or other online communities
Expand Down
2 changes: 1 addition & 1 deletion _includes/snippets/unsupported-installation-warning.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% alert warning %}
Hosting Kimai this way is not officially recommended. But in the best interest of the community, this quick-starter is provided to help you set up Kimai.
Hosting Kimai this way is neither officially recommended nor supported. But in the best interest of the community, this quick-starter is provided to help you set up Kimai.
If you run into issues with this documentation, please [share your updates]({{ site.kimai_v2_forum }}){:target=_blank .external-link} to improve it for the next person 🔥
{% endalert %}

0 comments on commit 92ad680

Please sign in to comment.