KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

vault-web

★ 31 Open GitHub ↗

Central web portal uniting all Vault-Web applications - secure access to cloud, password manager, chats, and more within a private VPN. Discord: https://discord.gg/YNN9EpqKd

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vault Web

**Vault Web** is the core project of the **Vault Web ecosystem**.
It is a full-stack application combining a **Spring Boot backend**, an **Angular frontend**, and a **PostgreSQL** database.

Vault Web acts as a **central dashboard** for a modular, self-hosted home server ecosystem. It provides a single entry point where multiple services are integrated into one secure web interface.

---

## What Vault Web Provides

Vault Web is responsible for:

- 💬 **Internal chats and collaboration tools**
- 🧑‍💻 **User and session management**
- 🔐 **Central authentication (JWT-based)**
- 🧩 **Frontend integration of external services**

Additional services are **not implemented directly in this repository**, but are embedded into the Vault Web frontend.

For example, file storage and file management are provided by the **Cloud Page** service:
👉 https://github.com/Vault-Web/cloud-page

---

## Project Structure

- 📁 [**DIRECTORY.md**](https://github.com/Vault-Web/vault-web/blob/main/DIRECTORY.md) – generated project structure overview
- 📚 [**Javadoc**](https://vault-web.github.io/vault-web) – backend API documentation

---

## Modules and Dependencies

Vault Web is composed of multiple modules and services:

- 📦 [**backend/**](./backend/README.md)  
  Spring Boot backend providing authentication, user management, collaboration
  features, REST APIs, and database access.

- 🌐 [**frontend/**](./frontend/README.md)  
  Angular frontend providing the Vault Web dashboard and user interface.

- ☁️ [**Cloud Page**](https://github.com/Vault-Web/cloud-page)
  File storage and file management service embedded into the Vault Web frontend.

- 🔐 [**Auth API Gateway**](https://github.com/Vault-Web/auth-api-gateway)  
  Authentication gateway service used within the Vault Web ecosystem.

- 🚀 [**deploy**](https://github.com/Vault-Web/deploy)  
  Production deployment stack, including submodules and backup configuration.

---

## Local Development

For local development, Vault Web uses **Docker**.

If you plan to contribute, clone your fork instead of the main repository.

### Requirements

- Docker & Docker Compose

---

## 1. Clone the Repository

```bash
git clone https://github.com/Vault-Web/vault-web.git
cd vault-web
```

---

## 2. Environment Configuration (`.env`)

⚠️ **You do NOT need to create a `.env` file manually.**
A `.env` file already exists in the repository.

You may adjust the values if needed, but make sure that:

> **The database configuration in `.env` matches exactly with the backend `application.properties`.**

---

## 3. Start PostgreSQL and pgAdmin

```bash
docker compose up -d
```

- PostgreSQL: `localhost:<DB_PORT>`
- pgAdmin: [http://localhost:8081](http://localhost:8081)

---

## Notes

This project is intended for **self-hosted and home-server environments**.

---

## Contributing

To contribute to this project, please fork the repository and create a feature branch in your fork.

Pull requests should be opened from your forked repository to the main branch of this repository.

If you are new to the project, feel free to open an issue before starting work to discuss your idea.

---

## Troubleshooting

If you encounter setup or startup issues, see [common_problems.md](./common_problems.md) for platform-specific troubleshooting guidance and fixes.

---

vault-web

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README