Quick Start Guide

Prerequisites

Before you begin, make sure your environment meets the following requirements. sarvaFeed is designed to run on any modern operating system including macOS, Linux, and Windows (via WSL).

You will need Docker 20.10 or later installed and running on your machine. If you prefer a non-Docker setup, Node.js 18+ and a PostgreSQL 15+ instance are required.

A terminal with basic command-line familiarity is assumed throughout this guide. All commands are shown for Unix-based shells but translate directly to PowerShell on Windows.

Installation

The fastest way to install sarvaFeed is with a single command. This pulls the latest stable image and prepares everything you need to start.

docker pull sarvaos/sarvafeed

Once the installation finishes, verify that the binary or container is available by running the version check command. You should see the latest version number printed to your terminal.

If you encounter permission errors on Linux, ensure your user is in the docker group or prefix the command with sudo.

Configuration

sarvaFeed uses environment variables for configuration. Copy the example environment file from the repository and adjust the values to match your setup.

At a minimum, you need to set the database connection string, a secret key for session encryption, and the base URL where the application will be served. All available options are documented in the example file with sensible defaults.

Configuration changes take effect after restarting the application. For Docker deployments, pass environment variables through your docker-compose.yml or docker run -e flags.

First Steps

With sarvaFeed installed and configured, start the application and open your browser to the configured URL. You will be greeted by the setup wizard which walks you through creating your first admin account.

After completing the setup wizard, take a few minutes to explore the dashboard. The sidebar navigation gives you access to all core features, and the settings page lets you fine-tune the application to your preferences.

We recommend inviting a teammate to test collaboration features early. sarvaFeed supports unlimited users on all plans, so there is no cost to adding your full team from day one.

Next Steps

Now that you have a running instance of sarvaFeed, here are some resources to help you get the most out of it:

• API Reference — integrate sarvaFeed with your existing tools
• Self-Hosting Guide — production deployment with Docker Compose, reverse proxy, and backups
• Changelog — see the latest features and improvements

Have questions or feedback? Open an issue on GitHub or join the community discussion. We actively respond to issues and love hearing how teams use sarvaFeed.