mirror of
https://github.com/aliasvault/aliasvault.git
synced 2026-03-20 15:41:40 -04:00
141 lines
3.4 KiB
Markdown
141 lines
3.4 KiB
Markdown
---
|
|
layout: default
|
|
title: Manual Setup
|
|
parent: Installation Guide
|
|
nav_order: 2
|
|
---
|
|
|
|
# Manual Setup
|
|
|
|
If you prefer to manually set up AliasVault, this README provides step-by-step instructions. Follow these steps if you prefer to execute all statements yourself.
|
|
|
|
## Prerequisites
|
|
|
|
- Docker and Docker Compose installed on your system
|
|
- OpenSSL for generating random passwords
|
|
|
|
## Steps
|
|
|
|
1. **Create required directories**
|
|
|
|
Create the following directories in your project root:
|
|
```bash
|
|
mkdir -p certificates/ssl certificates/app database logs/msbuild
|
|
```
|
|
|
|
2. **Create .env file**
|
|
|
|
Copy the `.env.example` file to create a new `.env` file:
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
3. **Set HOSTNAME**
|
|
|
|
Update the .env file with your hostname (default is localhost):
|
|
```bash
|
|
HOSTNAME=localhost
|
|
```
|
|
|
|
4. **Generate and set JWT_KEY**
|
|
|
|
Generate a random 32-char string for JWT token generation:
|
|
```bash
|
|
openssl rand -base64 32
|
|
```
|
|
|
|
Add the generated key to the .env file:
|
|
```bash
|
|
JWT_KEY=your_generated_key_here
|
|
```
|
|
|
|
5. **Generate and set DATA_PROTECTION_CERT_PASS**
|
|
|
|
Generate a random password for the data protection certificate:
|
|
```bash
|
|
openssl rand -base64 32
|
|
```
|
|
|
|
Add it to the .env file:
|
|
```bash
|
|
DATA_PROTECTION_CERT_PASS=your_generated_password_here
|
|
```
|
|
|
|
6. **Set PRIVATE_EMAIL_DOMAINS**
|
|
|
|
Update the .env file with allowed email domains. Use DISABLED.TLD to disable email support:
|
|
```bash
|
|
PRIVATE_EMAIL_DOMAINS=yourdomain.com,anotherdomain.com
|
|
```
|
|
Or to disable email:
|
|
```bash
|
|
PRIVATE_EMAIL_DOMAINS=DISABLED.TLD
|
|
```
|
|
|
|
7. **Set SUPPORT_EMAIL (Optional)**
|
|
|
|
Add a support email address if desired:
|
|
```bash
|
|
SUPPORT_EMAIL=support@yourdomain.com
|
|
```
|
|
|
|
8. **Generate admin password**
|
|
|
|
Build the Docker image for password hashing:
|
|
```bash
|
|
docker build -t installcli -f src/Utilities/AliasVault.InstallCli/Dockerfile .
|
|
```
|
|
|
|
Generate the password hash:
|
|
```bash
|
|
docker run --rm installcli "your_preferred_admin_password_here"
|
|
```
|
|
|
|
Add the password hash and generation timestamp to the .env file:
|
|
```bash
|
|
ADMIN_PASSWORD_HASH=<output_from_previous_command>
|
|
ADMIN_PASSWORD_GENERATED=2024-01-01T00:00:00Z
|
|
```
|
|
|
|
9. **Build and start Docker containers**
|
|
|
|
Build the Docker Compose stack:
|
|
```bash
|
|
docker compose build
|
|
```
|
|
|
|
Start the Docker Compose stack:
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
10. **Access AliasVault**
|
|
|
|
AliasVault should now be running. You can access it at:
|
|
|
|
- Admin Panel: https://localhost/admin
|
|
- Username: admin
|
|
- Password: [Use the password you set in step 8]
|
|
|
|
- Client Website: https://localhost/
|
|
- Create your own account from here
|
|
|
|
## Important Notes
|
|
|
|
- Make sure to save the admin password you used in step 8 in a secure location.
|
|
- If you need to reset the admin password in the future, repeat step 8 and restart the Docker containers.
|
|
- Always keep your .env file secure and do not share it, as it contains sensitive information.
|
|
|
|
## Troubleshooting
|
|
|
|
If you encounter any issues during the setup:
|
|
|
|
1. Check the Docker logs:
|
|
```bash
|
|
docker compose logs
|
|
```
|
|
2. Ensure all required ports (80 and 443) are available and not being used by other services.
|
|
3. Verify that all environment variables in the .env file are set correctly.
|
|
|
|
For further assistance, please refer to the project documentation or seek support through the appropriate channels.
|