Complete Guide

Documentation

Everything you need to install, configure, and manage your Intranet System.

Installation Features Administration AI Integration Tech Specs
Getting Started

Installation Guide

Follow these 5 steps to get your Intranet System running.

1

Install Node.js

Visit nodejs.org/en/download and download the appropriate version for your operating system. Install it like any other application.

2

Download the Project

Download the project folder and extract it. Open your terminal (or Command Prompt on Windows) and navigate to the folder using 'cd'.

cd [Path to Project Folder]
3

Install Dependencies

Run the command 'npm install' in your terminal. This will automatically download all necessary modules.

npm install
4

Start the Server

Start the server with 'npm start'. The server runs on port 3000 by default. You can adjust the port in server.js on line 17.

npm start

Note: To use port 443, you might need 'sudo' or administrator rights on macOS/Linux.

5

Log In & Change Password

The system is now accessible at http://localhost:3000. Log in using the default credentials:

Username: admin
Password: 123456

Important: Please change this password immediately after your first login in your profile settings.

Capabilities

Built-in Features

User Management

Profiles & Teams

Users can upload avatars, change passwords, and manage personal information. Teams bundle users for better organization and collaboration.

Documents & Events

Upload PDF documents or write Markdown notes. Create company events with RSVP functionality for all employees.

Real-time Updates

Thanks to Socket.io, users receive notifications and updates in real-time without having to reload the page.

Management

Administration & Control

As an administrator, you have full control. Access advanced features via the admin menu.

User & Permissions

Assign permissions granularly: Who can upload documents? Who can create events? Who has access to AI features?

Settings

Customize company name, logo, and global system settings. Configure API keys for external services.

Database & Backup

SQLite3 for data storage. Create regular backups through the admin panel to protect your data.

Artificial Intelligence

AI Agent Integration

AI Models

GPT-4, Claude 3.5 & More

The system supports modern AI models. To enable AI features, store a valid API key in the admin panel. Users with appropriate permissions can then ask questions or analyze data directly in the dashboard.

Supported: OpenAI / Anthropic APIs

Security & Privacy

All API requests are encrypted during transmission. Your data is not cached and deleted immediately after processing.

Configuration

Set up API keys and model preferences in the admin settings panel. Change models or providers anytime.

Technical

Technical Specifications

Built on a robust and scalable technology stack.

Technology Stack

Node.js 20+
Express 5.0
SQLite3
Socket.io 4.8
EJS Templates
Bcryptjs

System Requirements

  • Node.js version 20 or higher
  • At least 512 MB RAM
  • 100 MB free disk space
  • WebSocket support (Socket.io)
  • HTTPS recommended for production

Main Dependencies

  • express — Core web server
  • sqlite3 — Local database (no DB server needed)
  • socket.io — Real-time communication
  • multer — File handling & uploads
  • marked — Markdown parser
  • bcryptjs — Password encryption

Scalability

The system is optimized for teams up to 1000 employees. For larger installations, we recommend using PostgreSQL instead of SQLite and running multiple server instances behind a load balancer.

Help & Support

Support & Community

GitHub Repository

Source code, issue tracking, and community discussions.

View on GitHub

Documentation Wiki

Community knowledge base and troubleshooting guides.

Visit Wiki

Email Support

Get in touch for custom solutions and enterprise support.

Contact