Documentation

Installation Features Administration AI Agent Tech Specs

Getting Started

Follow these steps to install the Intranet System on your own server or local machine. No prior knowledge required.

Install Node.js

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

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]

Install Dependencies

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

npm install

Start the Server

Start the server with 'npm start'. The server runs on port 3000 by default. You can adjust the port (e.g., to 443 for HTTPS) directly in the server.js file on line 17.

npm start

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

Log In & Change Password

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

Username: admin
Password: 123456

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

Features

User Management

Profiles & Teams

Users can upload avatars, change passwords, and manage personal info. Teams group users for better organization.

Content

Documents & Events

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

Communication

Real-time Interaction

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

Administration

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

User & Permissions

You can assign permissions granularly: Who can upload documents? Who can create events? Who has AI access?

Settings

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

AI Agent Integration

The system supports modern AI models like GPT-4, Claude 3, and more.

Modell: GPT-4o / Claude 3.5 Sonnet API: OpenAI / Anthropic

To use the AI agent, you must store a valid API key in the admin panel. Users with the appropriate permission can then ask questions or analyze data directly in the dashboard.

Technical Specifications

Built on a robust and scalable stack.

Node.js 20+ Express 5.0 SQLite3 Socket.io 4.8 EJS Templates Multer (Uploads) Bcryptjs (Security)

Main Dependencies

  • express: Core Web-Server
  • sqlite3: Lokale Datenbank (kein DB-Server nötig)
  • socket.io: Echtzeit-Kommunikation
  • multer: Dateihandling
  • marked: Markdown-Parser