Astroluma

# Astroluma

<p align="center">
        <img src="https://getastroluma.com/img/logo.svg" alt="Astroluma" width="100" />
        <br /><br />
        <a href="https://github.com/Sanjeet990/Astroluma/releases">
          <img src="https://img.shields.io/badge/version-1.0.1-blue?style=for-the-badge" />
        </a>
        <a href="https://hub.docker.com/r/sanjeet990/astroluma">
          <img src="https://img.shields.io/docker/pulls/sanjeet990/astroluma?style=for-the-badge&logo=docker" />
        </a>
        <a href="https://github.com/Sanjeet990">
          <img src="https://img.shields.io/github/stars/Sanjeet990/Astroluma?style=for-the-badge&logo=github" />
        </a>
        <a href="https://github.com/Sanjeet990/Astroluma/blob/main/LICENSE">
          <img src="https://img.shields.io/github/license/Sanjeet990/Astroluma?style=for-the-badge" />
        </a>
        <br /><br />
A powerful, self-hosted home lab dashboard built with the MERN stack.

</p>

## Overview

Astroluma is a feature-rich, productivity oriented, user-friendly dashboard designed to help you manage multiple aspects of your daily tasks and services. Built with flexibility in mind, it allows you to control various features like task management, device monitoring, app integration, and real-time weather updates, all from a single platform. With its responsive design and dynamic configuration options, Astroluma offers a unique blend of customization, usability, and productivity.

![Listing View](https://getastroluma.com/ss/01-home-featured.png)

## Updates

**Jan 21, 2025**
- Astroluma v1.0.2 is released. Check the full changelog [here](https://github.com/Sanjeet990/Astroluma/releases)

## Features

### Core Features
- **Multi-User Support**: Individual instances for each user
- **Links Organization**: Categorize and organize links with nested categories
- **Featured Page**: Showcase important categories and links
- **Custom Domain Support**: Works simultaneously with custom domains and IPs
- **Network Device Management**: 
  - IPv4 network device scanning
  - Wake-on-LAN support
  - Device status monitoring

### Productivity Tools
- **Todo List Manager**: Create and manage multiple todo lists
- **Snippet Manager**: Store and organize code snippets
- **TOTP Generation**: Built-in Time-Based One-Time Password generation
- **Custom Page Creation**: Create and publish custom pages

### Integrations
- **Stream Hub**: Support for IP camera streams
- **Weather Integration**: Real-time weather updates
- **Third-Party Apps**: 
  - Bazarr
  - FileBrowser
  - FreshRSS
  - GitHub
  - HTML Code
  - Heimdall
  - Immich
  - Linkace
  - NextCloud
  - Nginx Proxy Manager
  - Portainer
  - Proxmox
  - Sonarr
  - Speed Test Tracker
  - TrueNAS Scale (Core untested)
  - Uptime Kuma
  - YouTube
  - More coming soon!
- **Custom Integration Support**: Create your own app integrations

### Customization
- **Themes**: 15 built-in themes with more in development
- **Icon Pack Support**: User configurable icon pack support. Find icons [here](https://getastroluma.com/icons)
- **Flexible Layout**: Customizable sidebar and category placement

## Installation

### On Docker:

1. Create a docker-compose.yml file. Best way to do this is to use the [Astroluma Compose](https://getastroluma.com/compose)

Open Astroluma Compose and chose your preffered settings to generate your docker-compose.yml file.

Alternatively, create a docker-compose.yml similar to this:

```yml title="docker-compose.yml"
version: '3.8'

services:
  app:
    image: sanjeet990/astroluma:latest
    container_name: astroluma
    ##ports:
    ##  - "8000:8000"
    environment:
      PORT: 8000
      NODE_ENV: production
      SECRET_KEY: a2c5f9a8b2d7e1a7f2c9c8d9b5f7a3d5
      MONGODB_URI: mongodb://localhost:27017/astroluma
    volumes:
      - uploads_data:/app/storage/uploads
      - uploads_apps:/app/storage/apps
    depends_on:
      - mongodb
    restart: always
    network_mode: host

  mongodb:
    image: mongo:6.0
    container_name: astroluma_mongodb
    ports:
      - "27017:27017"
    volumes:
      - mongo_data:/data/db
    restart: always


volumes:
  mongo_data:
    driver: local
  uploads_data:
    driver: local

```

If you're still unsure about creating your own config, please contact [here](https://getastroluma.com/contact).

2. Bring up your stack by running:

```bash 
docker-compose up -d
```
If using docker-compose-plugin:

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

Detailed installation doc: [Installation Guide](https://getastroluma.com/docs/getting-started/installation/)

## Demo and Resources

- **Website**: [https://getastroluma.com/](https://getastroluma.com/)
- **Live Demo**: Coming Soon!
- **Screenshots**: [https://getastroluma.com/screenshots](https://getastroluma.com/screenshots)

## FAQs

FAQ list is continuously being updated [here](https://getastroluma.com/faqs).

## Credits

A big shoutout to the people/projects who made this project possible. Check the credits [here](https://getastroluma.com/credits).

## License

This project is licensed under the GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007.

## Contributing

Contributions are welcome! Please feel free to submit pull requests.

## Maintainer

Maintained by [@Sanjeet990](https://github.com/Sanjeet990)

## Support

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/sanjeet990)