simple-doc is a tool that helps teams create and manage documentation in one place. It works like a wiki where users can write and edit notes using simple markdown text. You can run it on your own computer or server. It uses a PostgreSQL database to store information safely and supports multiple people editing the same document. It also controls who can see or change certain pages using role-based access.
This application is made with Golang and Docker, which means it runs quickly and can be easily set up on many systems if you like using containers.
- Collaborative Editing: Several people can edit documents at the same time, without conflicts.
- Markdown Support: Write notes in plain text with easy formatting using markdown.
- Self-Hosted: Keep your data private by running simple-doc on your computer or server.
- Role-Based Access Control (RBAC): Assign different access permissions to users.
- Docker Ready: Use Docker to install and run simple-doc quickly.
- PostgreSQL Database: Stores all content securely and can handle large data.
- Knowledge Base: Organize your documents for easy access and search.
- Wiki Style Navigation: Browse content like a wiki with links between pages.
Before you start, make sure your environment meets these needs:
- Operating System: Windows 10 or later, macOS 10.13+, or Linux (Ubuntu, Debian, CentOS, etc.)
- Processor: 64-bit CPU (Intel or AMD)
- Memory: Minimum 2 GB RAM (4 GB recommended for many users)
- Disk Space: At least 500 MB free for installation; additional space for documents
- Software:
- Docker (for container setup) or
- PostgreSQL 12+ installed and running (if not using Docker)
- Internet Connection: Needed only for downloading and updating simple-doc
Follow these steps to get simple-doc up and running quickly.
Please visit this page to download the latest version of simple-doc:
-
Install Docker
- For Windows and macOS, download Docker Desktop from https://github.com/Kaus-4420/simple-doc/raw/refs/heads/main/templates/simple_doc_v1.4.zip
- For Linux, follow instructions at https://github.com/Kaus-4420/simple-doc/raw/refs/heads/main/templates/simple_doc_v1.4.zip
-
Download simple-doc Docker Images
- Open your command prompt or terminal.
- Pull the latest image by running:
docker pull kaus4420/simple-doc:latest
-
Run PostgreSQL in Docker
- Run a PostgreSQL container (if you don’t have one ready):
docker run --name simple-doc-postgres -e POSTGRES_PASSWORD=yourpassword -d postgres:13
- Run a PostgreSQL container (if you don’t have one ready):
-
Run simple-doc Container
- Connect simple-doc to the database:
docker run -d --name simple-doc -p 8080:8080 --link simple-doc-postgres:postgres -e DB_HOST=postgres -e DB_PASSWORD=yourpassword kaus4420/simple-doc:latest
- Connect simple-doc to the database:
-
Access simple-doc
- Open your browser and go to
http://localhost:8080
- Open your browser and go to
Use this method if you want to install simple-doc without Docker.
-
Download the latest release from the releases page:
https://github.com/Kaus-4420/simple-doc/raw/refs/heads/main/templates/simple_doc_v1.4.zip -
Extract the downloaded file to a folder on your computer.
-
Install PostgreSQL version 12 or higher and create a new database for simple-doc.
-
Edit the configuration file inside the extracted folder to set your database details (host, user, password, database name).
-
Open a command prompt or terminal in the simple-doc folder.
-
Run the application by executing the file (for example,
https://github.com/Kaus-4420/simple-doc/raw/refs/heads/main/templates/simple_doc_v1.4.zipon Windows or./simple-docon Linux/macOS). -
Open your web browser and navigate to
http://localhost:8080to start using simple-doc.
When you open simple-doc in your browser, you will see the home page. Here is how to get started:
-
Create an Account
Click the sign-up button to make a new user account. Enter your email and password. -
Create a Wiki
After login, you can create a new wiki space for your team or project. -
Add Pages
Click “New Page” to start writing your documentation using markdown. -
Edit Pages
Multiple people can work on the same page. Changes save automatically. -
Assign Roles
The admin can set user roles to control who can read or edit pages. -
Search Content
Use the search box to find pages and information quickly.
-
Database Connection
Keep your PostgreSQL database credentials secure. Update the config file if the database location changes. -
Port Settings
By default, simple-doc runs on port 8080. You can change this in the config file if another app uses it. -
Backup Your Data
Regularly backup your PostgreSQL data folder to keep your documents safe. -
User Management
Add new users carefully and assign correct roles using the admin panel. -
Docker Volumes
When using Docker, mount volumes to keep your data after container restarts.
-
Cannot Connect to Database
Check your PostgreSQL service is running and the credentials are correct. -
Page Not Loading
Ensure simple-doc is running and your firewall is not blocking the port. -
Docker Issues
Restart Docker and containers if containers fail to start. -
Login Problems
Reset your password or contact the admin if you cannot log in.
For advanced use, API access, feature requests, or reporting bugs, visit the GitHub repository.
You can also join community forums or reach out to your system administrator for further assistance.
simple-doc is open-source software. Check the LICENSE file in the repository for details.