Skip to main content

Gotify

Get Notified Your Way: A Simple Guide to Using Gotify for Personal Notifications

In today's digital age, timely and reliable notifications are crucial for keeping track of important events and updates. Gotify offers a robust solution for self-hosted notifications, enabling you to receive and manage notifications on your own terms. This blog post explores the features of Gotify, provides Docker-Compose installation instructions, and walks you through the basic setup.

What is Gotify?

Gotify is an open-source notification server that allows you to manage and send notifications from various applications and services. It is designed to be lightweight, easy to deploy, and highly customizable, making it an excellent choice for anyone who needs a self-hosted notification system. Gotify supports real-time notifications, integrates with various applications, and provides a clean and intuitive user interface for managing notifications.

Key Features of Gotify

1. Real-Time Notifications

  • Instant Delivery: Receive notifications in real-time, ensuring that you never miss an important update.
  • WebSocket Support: Utilizes WebSockets for instant communication between the server and clients.

2. User Management

  • Multiple Users: Manage multiple users with individual notification preferences and settings.
  • User Roles: Define user roles with different permissions for managing notifications and settings.

3. Customizable Notifications

  • Customizable Messages: Customize notification messages with various formats and styles.
  • Priority Levels: Set different priority levels for notifications to help organize and prioritize important updates.

4. API Integration

  • REST API: Integrate Gotify with other applications using its REST API, allowing you to send notifications programmatically.
  • Webhook Support: Set up webhooks to trigger notifications from external services.

5. Mobile and Desktop Clients

  • Mobile Apps: Access Gotify notifications through mobile apps available for iOS and Android.
  • Desktop Access: Use the Gotify web interface to view and manage notifications from your desktop.

6. Secure and Private

  • Self-Hosted: Host Gotify on your own server to maintain full control over your notifications and data.
  • HTTPS Support: Secure your Gotify server with HTTPS for encrypted communication.

Installing Gotify Using Docker-Compose

Deploying Gotify with Docker-Compose simplifies the setup process and ensures a consistent environment. Follow these steps to install Gotify using Docker-Compose.

Step-by-Step Docker-Compose Installation

  1. Install Docker and Docker-Compose

    Ensure Docker and Docker-Compose are installed on your system. For installation instructions, refer to the Docker installation guide and the Docker-Compose installation guide.

  2. Create a Docker-Compose File

    Create a directory for your Gotify setup and navigate to it. Create a docker-compose.yml file with the following content:

    yaml 
    services:
  gotify:
    image: gotify/server:latest
    container_name: gotify
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./data:/app/data
    environment:
      - GOTIFY_SERVER_PORT=80
      - GOTIFY_SERVER_SSL=off
    restart: unless-stopped

  3. Start Gotify

    Open a terminal, navigate to the directory containing the docker-compose.yml file, and run the following command:

    sh 
    docker-compose up -d

    This command will pull the Gotify Docker image and start the container in detached mode.

  4. Access the Gotify Web UI

    Open your web browser and navigate to http://localhost to access the Gotify web interface. You can use this interface to configure your notification settings and manage users.

Basic Setup Instructions

Once Gotify is up and running, follow these steps to configure your notification server.

Step 1: Configure Gotify

  • Access the Admin Panel: Open the Gotify web UI and log in using the default admin credentials. Change these credentials to secure your server.
  • Set Up Notification Channels: Configure different notification channels and settings based on your needs.
  • Add Users: Create additional user accounts and assign roles as needed.

Step 2: Integrate Applications

  • Use the REST API: Utilize Gotify's REST API to send notifications from other applications. Refer to the Gotify API documentation for detailed instructions.
  • Set Up Webhooks: Configure webhooks to trigger notifications from external services and applications.

Step 3: Secure Your Server

  • Configure HTTPS: Set up HTTPS to encrypt communication between your server and clients. You can achieve this by using a reverse proxy like Nginx or Traefik.
  • Backup Your Data: Regularly back up your Gotify data to prevent data loss.

Conclusion

Gotify provides an effective solution for managing notifications in a private, self-hosted environment. Its real-time capabilities, user management features, and API integrations make it a versatile tool for various applications. By following the Docker-Compose installation and basic setup instructions, you can quickly deploy Gotify and start receiving notifications securely and efficiently. For further customization and advanced configurations, refer to the Gotify documentation and explore the Gotify GitHub repository.

Back to top