Add minimum docker version instructions (#963)

This commit is contained in:
Leendert de Borst
2025-06-26 21:07:06 +02:00
committed by Leendert de Borst
parent db479182f0
commit 0f02412db2
3 changed files with 11 additions and 7 deletions

View File

@@ -5,8 +5,8 @@ AliasVault is a privacy-first password and email alias manager. Create unique id
[![.NET E2E Tests (with Sharding)](https://github.com/lanedirt/AliasVault/actions/workflows/dotnet-e2e-tests.yml/badge.svg)](https://github.com/lanedirt/AliasVault/actions/workflows/dotnet-e2e-tests.yml)
[<img src="https://img.shields.io/sonar/quality_gate/lanedirt_AliasVault?server=https%3A%2F%2Fsonarcloud.io&label=Sonarcloud&logo=sonarcloud">](https://sonarcloud.io/summary/new_code?id=lanedirt_AliasVault)
[<img alt="Discord" src="https://img.shields.io/discord/1309300619026235422?logo=discord&logoColor=%237289da&label=Discord&color=%237289da">](https://discord.gg/DsaXMTEtpF)
<a href="https://app.aliasvault.net">Try the cloud version 🔥</a> | <a href="https://aliasvault.net?utm_source=gh-readme">Website </a> | <a href="https://docs.aliasvault.net?utm_source=gh-readme">Documentation </a> | <a href="#self-hosting">Self-host instructions</a>
<a href="https://app.aliasvault.net">Try the cloud version 🔥</a> | <a href="https://aliasvault.net?utm_source=gh-readme">Website </a> | <a href="https://docs.aliasvault.net?utm_source=gh-readme">Documentation </a> | <a href="#self-hosting">Self-host instructions</a>
⭐ Star us on GitHub — it motivates us a lot!
@@ -47,7 +47,7 @@ Built on 15 years of experience, AliasVault is independent, open-source, self-ho
## Cloud-hosted
Use the official cloud version of AliasVault at [app.aliasvault.net](https://app.aliasvault.net). This fully supported platform is always up to date with our latest release.
AliasVault is available on:
AliasVault is available on:
- [Web (universal)](https://app.aliasvault.net)
- [Chrome](https://chromewebstore.google.com/detail/aliasvault/bmoggiinmnodjphdjnmpcnlleamkfedj)
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/aliasvault/)
@@ -72,7 +72,7 @@ This method uses pre-built Docker images and works on minimal hardware specifica
- 1 vCPU
- 1GB RAM
- 16GB disk space
- Docker installed
- Docker (20.10+) and Docker Compose (2.0+)
```bash
# Download install script from latest stable release

View File

@@ -10,7 +10,8 @@ nav_order: 1
If you prefer to manually set up AliasVault instead of using the `install.sh` script, this README provides step-by-step instructions.
**Prerequisities:**
- Docker and Docker Compose installed on your system
- Docker (20.10+) and Docker Compose (2.0+) installed on your system
- See instructions: [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)
- Knowledge of working with direct Docker commands
- Knowledge of .env files
- OpenSSL for generating random passwords

View File

@@ -22,7 +22,10 @@ To get AliasVault up and running quickly, run the install script to pull pre-bui
- 1 vCPU
- 1GB RAM
- 16GB disk space
- Docker installed
- Docker
- Docker CE (minimum version 20.10)
- Docker Compose (minimum version 2.0)
- Refer to the official installation instructions: [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)
### Installation steps
1. Download the install script to a directory of your choice. All AliasVault files and directories will be created in this directory.
@@ -46,7 +49,7 @@ chmod +x install.sh
- Client: `https://localhost`
- Admin: `https://localhost/admin`
> Note: if you do not wish to run the `install.sh` wizard but want to use Docker commands directly, follow the [manual setup guide](advanced/manual-setup.md). We do however encourage the use of `install.sh` as it will guide you through all configuration steps and allow for easy updating your AliasVault instance later.
> Note: if you do not wish to run the `install.sh` wizard but want to use Docker commands directly, follow the [manual setup guide](advanced/manual-setup.md). We do however encourage the use of `install.sh` as it will guide you through all configuration steps and allow you to easily update your AliasVault instance later.
---