diff --git a/README.md b/README.md index d901f019f..d34088051 100644 --- a/README.md +++ b/README.md @@ -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) [](https://sonarcloud.io/summary/new_code?id=lanedirt_AliasVault) [Discord](https://discord.gg/DsaXMTEtpF) - -Try the cloud version 🔥 | Website | Documentation | Self-host instructions + +Try the cloud version 🔥 | Website | Documentation | Self-host instructions ⭐ 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 diff --git a/docs/installation/advanced/manual-setup.md b/docs/installation/advanced/manual-setup.md index 08e927534..fdd1c290d 100644 --- a/docs/installation/advanced/manual-setup.md +++ b/docs/installation/advanced/manual-setup.md @@ -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 diff --git a/docs/installation/install.md b/docs/installation/install.md index 8a97dbdc9..af8c8661e 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -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. ---