Linux Installation

Before installing Pulsar AI, ensure your system meets the following requirements:
1. A compatible NVIDIA GPU (with CUDA 12.1+) or AMD GPU (with ROCm 6.1+)
2. Ubuntu 20.04 or later (other Linux distributions may work but are not officially supported)
3. At least 8GB of RAM (16GB or more recommended)
4. At least 50GB of free disk space
5. Internet connection for downloading dependencies and models

‍If you already have a Pulsar Server, simply activate it and/or connect to it through Pulsar UI. You can simply download only Pulsar UI here.

Github installation Guide

1. Docker Compose Installation (Recommended)

This method is the easiest and most reliable way to install Pulsar AI. By following the steps below, you will install two new desktop applications: Pulsar Server and Pulsar UI.

1. Install Docker and Docker Compose:

sudo apt-get update
sudo apt-get install docker.io docker-compose

2. Add your user to the docker group:

sudo usermod -aG docker $USER

Log out and log back in for this change to take effect.

3. Download the Pulsar installer script:

wget https://raw.githubusercontent.com/astramind-ai/Pulsar/refs/heads/main/installer/installer.sh

4. Make the script executable and Run the installer script:

chmod +x installer.sh
./installer.sh

5. Follow the prompts in the installer. It will:
. Check for a compatible GPU
. Install Docker and Docker Compose if needed
. Set up the necessary Docker Compose configuration
. Create and configure the .env file
. Start the Pulsar services

6. Once the installation is complete, you will find the Pulsar Server and Pulsar UI desktop applications.on the Pulsar Server, and once it is ready, open Pulsar UI. You can access it locally at http://localhost:40000.

To ensure that everything is working correctly, open a terminal or command prompt and run: docker ps
The status of the Pulsar server should show as healthy.

If you have any problems please contact us to Info AstraMind , or open an issues to Github

2. Manual Installation

If you prefer more control over the installation process or cannot use Docker, follow these steps. This guide will walk you through the process of setting up Pulsar AI manually, including cloning the GitHub repository, setting up dependencies, configuring PostgreSQL, and more.

Clone the GitHub Repository:

git clone https://github.com/astramind-ai/pulsar.git ~/pulsar
cd ~/pulsar

2.1 GPU Driver

For NVIDIA GPUs:

1. Follow the official NVIDIA CUDA 12.1+ installation guide: CUDA Installation Guide

2. Verify the installation:

nvidia-smi

For AMD GPUs:

1. Follow the official ROCm installation guide: ROCm Installation Guide

2. Verify the installation:

rocm-smi

2.2 Python Environment

1. Install Miniconda:

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh

2. Create a new conda environment:

conda create -n pulsar python=3.10
conda activate pulsar

2.3 Set Up the Conda Environment

conda create -n pulsar python=3.10
conda activate pulsar

1. Install PyTorch with GPU support:
For NVIDIA GPUs:

conda install pytorch torchvision torchaudio pytorch-cuda=12.1 -c pytorch -c nvidia

For AMD GPUs:

pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm6.1

2. Install other dependencies:

pip install -r requirements.txt

2.4 PostgreSQL

1. Install PostgreSQL:

sudo apt update
sudo apt install postgresql postgresql-contrib

2. Start and enable PostgreSQL service:

sudo systemctl start postgresql
sudo systemctl enable postgresql

3. Create a database and user for Pulsar:

sudo -u postgres psql

In the PostgreSQL prompt, run:

CREATE DATABASE pulsar;
CREATE USER pulsaruser WITH PASSWORD 'your_secure_password';
GRANT ALL PRIVILEGES ON DATABASE pulsar TO pulsaruser;
\q

2.5 Configure Pulsar

1. Create a .env file in the pulsar directory:

touch ~/pulsar/.env

2. Open the .env file in a text editor and add the following content:

PULSAR_DB_PASSWORD='your_password_here'
PULSAR_HF_TOKEN='your_huggingface_token_here'
PULSAR_SHOULD_SEND_PRIVATE_TOKEN=false
PULSAR_NGROK_TOKEN='your_ngrok_token_here'
PULSAR_DB_USER=astramind
PULSAR_DB_NAME=localhost:5432/pulsar
PRIMARY_USE=general
IS_ADULT_CONTENT=false

2.6 Set Up the Database

1. Run the database migrations:

alembic upgrade head

2.7 Start Pulsar

python main.py

To ensure that everything is working correctly, open a terminal or command prompt and run: docker ps
The status of the Pulsar server should show as healthy.

Troubleshooting

If you encounter issues during installation:
1. Check the Pulsar logs:
‍. For Docker:

docker-compose logs pulsar

. For manual installation: Check the console output or log files in the Pulsar directory
2. Ensure all prerequisites are correctly installed and configured
3. Verify that your GPU drivers are correctly installed and functioning
4. Check that PostgreSQL is running and accessible
5. Make sure all environment variables in the .env file are correctly set

If problems persist, please open an issue on the Pulsar AI GitHub repository with detailed information about the error and your system configuration.
For additional support, join our Discord community.

Replace your_secure_password with the password you set for the PostgreSQL user in Step 2.4.
‍
‍PULSAR_HF_TOKEN (HuggingFace Token)This token is crucial for accessing HuggingFace's model repository. Without it, you won't be able to download and use many of the AI models that power Pulsar's functionality.
‍To obtain your token:
Go to HuggingFace and create an account if you don't have one.
‍Navigate to your profile settings and find the "Access Tokens" section.
‍Create a new token and copy it into your .env file.
Setting this token allows Pulsar to access a wide range of powerful AI models, significantly enhancing its capabilities.

PULSAR_SHOULD_SEND_PRIVATE_TOKEN: Setting this to true is highly recommended. It allows Pulsar to use your HuggingFace token to access private or gated models. This can unlock advanced features and improve Pulsar's performance. While you can set it to false for privacy reasons, doing so may limit Pulsar's functionality.

PULSAR_NGROK_TOKEN (Ngrok Token)Ngrok is a tool that creates secure tunnels to localhost, allowing you to expose Pulsar to the internet securely. This is particularly useful if you want to access Pulsar remotely or collaborate with others.
‍To obtain your Ngrok token:
Sign up for an account at Ngrok.
‍In your dashboard, you'll find your authtoken.
‍Copy this token into your .env file.

You can find different tutorials on how to use pular at: Tutorial

Next Download Pulsar Client (Pulsar UI)

After you’ve installed Pulsar Server, download the Pulsar Client to obtain the Pulsar UI.

Linux

If you have any problems please contact us to Info AstraMind , or open an issues to Github

3. Start chatting!

How Pulsar Works:

Install
Pulsar Server

Sets Up Pulsar: It initializes all the necessary parts that Pulsar needs to function properly;
‍Fetches Essential Models: It downloads the models that power the app's features, enabling everything from basic functions to advanced capabilities;
Protects Your Data: All your conversation histories are stored directly on your device. This means your chats are private and secure, as they aren't saved online;
‍Supports Pulsar Client: Pulsar Server acts as the backbone for Pulsar Client. It allows the client application to connect and interact smoothly with the Pulsar App;
‍Key Features:Local Storage: Both the models and your chat histories are kept on your device. This ensures that your information stays private and under your control without needing an internet connection;
‍Compatibility: Currently, Pulsar Server works on Windows and Linux operating systems.
Pulsar Server is a crucial application needed to run the Pulsar App (Pulsar Client).

Install
Pulsar Client

After downloading and installing Pulsar Server and creating an account, proceed to download Pulsar Client. Pulsar Client is the application that all users, including you, will use to access Pulsar App through your account on the Pulsar Server. Here’s how it works:
‍
Start Pulsar Server: Once the server is up and running, anyone with the necessary credentials can connect;
Download and Install Pulsar Client: Available for Windows, Linux;
Create Your Personal Account: Using Pulsar Client, you can create your own internal account, allowing you to interact privately and independently from other users.
‍
In summary, Pulsar Client enables you to use Pulsar App easily and securely, ensuring a personalized and private experience.

Share with
Friends and Family
and Start Chatting

Share your account with friends and family while maintaining privacy and personalization for each user.
‍Shared Server Name: All connected users will use the same server name.
‍Individual User Profiles: Each person can create their own unique user profile. Customize and design your own characters to reflect your personal style. Personalized Experience: Personalize your interface and settings to suit your preferences.Keep your chats private, ensuring that your conversations remain confidential.
‍Local Data Management: All user data is managed locally on the server computer.No data is ever sent or stored online, guaranteeing complete privacy and security.