Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tristanpoland/reaper-docs
A simple selfhosted knowledge base designed for speed. Built by Tristan Poland
https://github.com/tristanpoland/reaper-docs
Last synced: 26 days ago
JSON representation
A simple selfhosted knowledge base designed for speed. Built by Tristan Poland
- Host: GitHub
- URL: https://github.com/tristanpoland/reaper-docs
- Owner: tristanpoland
- Created: 2024-11-27T09:50:23.000Z (28 days ago)
- Default Branch: main
- Last Pushed: 2024-11-27T17:32:48.000Z (28 days ago)
- Last Synced: 2024-11-27T18:19:50.272Z (28 days ago)
- Language: Rust
- Homepage:
- Size: 22.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Reaper Docs
A secure, authenticated documentation management system built with Rust and Rocket.
## Features
- Markdown document management
- User authentication and authorization
- Role-based access control (Admin/User)
- Document search functionality
- Document metadata (reading time, word count, previews)
- Secure session management
- Admin user management panel
## Prerequisites
- Rust and Cargo
- SQLite3
- A web browser with JavaScript enabled
## Setup
1. Clone the repository
```bash
git clone https://github.com/yourusername/reaper-docs.git
cd reaper-docs
```
2. Create necessary directories
```bash
mkdir docs
mkdir static
```
3. Build and run
```bash
cargo build --release
cargo run
```
The server will start at `http://localhost:8000`
## Initial Login
Default admin credentials:
- Username: `admin`
- Password: `admin`
**Important:** Change these credentials after first login.
## Usage
### User Management
- `/login` - User login
- `/register` - New user registration
- `/profile` - User profile management
- `/admin/users` - User management (admin only)
### Document Management
- `/` - Document list
- `/doc/` - View document
- `/edit/` - Edit document
- `/search?q=` - Search documents
## Security Features
- Password hashing with bcrypt
- Secure session management
- CSRF protection
- Private cookie encryption
- SQL injection protection
## License
MIT