Loading repository data…
Loading repository data…
thkox / repository
Home AI Server provides the backend infrastructure for the Home AI system. It manages user data, conversations, and the interaction with Large Language Models (LLMs). The server runs locally, ensuring that all user data stays within the local network for maximum privacy.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
Home AI Server provides the backend infrastructure for the Home AI system. It manages user data, conversations, and the interaction with Large Language Models (LLMs). The server runs locally, ensuring that all user data stays within the local network for maximum privacy.
Install Dependencies:
Clone the Repository:
git clone https://github.com/yourusername/home-ai-server.git
cd home-ai-server
Set Up Environment Variables:
Edit the .env file with your desired configuration.
Build and Run the Docker Container:
docker-compose build
docker-compose up
The server will start on the default port 8000. You can access the API at http://localhost:8000.
Root:
GET /: Read RootAuthentication:
POST /auth/register: Register a new user.POST /auth/login: Log in and receive a JWT token.Users:
PUT /users/me/password: Change the current user's password.PUT /users/{user_id}/password: Change any user's password (admin only).GET /users/me/details: Get authenticated user's details.PUT /users/me/profile: Update the authenticated user's profile.PUT /users/{user_id}/profile: Update any user's profile (admin only).Conversations:
POST /conversations: Start a new conversation with the LLM.GET /conversations/{conversation_id}: Get a specific conversation by ID.GET /conversations/me: Get all conversations of the authenticated user.DELETE /conversations/{conversation_id}: Delete a conversation by ID.GET /conversations/{conversation_id}/messages: Get messages of a specific conversation.POST /conversations/{conversation_id}/continue: Continue an existing conversation.Documents:
POST /documents/upload: Upload a document for analysis.GET /documents/{document_id}: Get document details by ID.GET /documents/me: Retrieve all documents uploaded by the authenticated user.DELETE /documents/{document_id}: Delete a document by ID.The server uses PostgreSQL to store user profiles, conversations, and document metadata. Here's an overview of the main tables:
docker-compose logs..env file.This project is licensed under the MIT License - see the LICENSE file for details.