156 lines
3.7 KiB
Markdown
156 lines
3.7 KiB
Markdown
# Personal Wiki.js Setup for Home Server
|
|
|
|
This repository contains everything you need to set up your personal Wiki.js instance on your home server.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
1. **Run the setup script:**
|
|
```bash
|
|
./setup.sh
|
|
```
|
|
|
|
2. **Access your wiki:**
|
|
- Open http://localhost:3000 in your browser
|
|
- Complete the initial setup wizard
|
|
- Create your administrator account
|
|
|
|
## 📁 Project Structure
|
|
|
|
```
|
|
wikiaodh/
|
|
├── docker-compose.yml # Docker services configuration
|
|
├── .env # Environment variables (passwords, etc.)
|
|
├── setup.sh # Automated setup script
|
|
├── README.md # This file
|
|
└── data/ # Created automatically for persistent data
|
|
├── wiki/ # Wiki application data
|
|
├── db/ # PostgreSQL database files
|
|
└── assets/ # Uploaded media and assets
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
### Environment Variables (.env)
|
|
- `DB_PASSWORD`: Secure password for PostgreSQL database
|
|
- `WIKI_URL`: The URL where your wiki will be accessible
|
|
- `TZ`: Your timezone (default: Europe/London)
|
|
|
|
### Ports
|
|
- **3000**: Wiki.js web interface (http://localhost:3000)
|
|
- **5432**: PostgreSQL database (internal only)
|
|
|
|
## 📋 Management Commands
|
|
|
|
```bash
|
|
# Start the wiki
|
|
docker-compose up -d
|
|
|
|
# Stop the wiki
|
|
docker-compose down
|
|
|
|
# View logs
|
|
docker-compose logs -f
|
|
|
|
# Restart services
|
|
docker-compose restart
|
|
|
|
# Update to latest version
|
|
docker-compose pull
|
|
docker-compose up -d
|
|
```
|
|
|
|
## 💾 Backup & Restore
|
|
|
|
### Backup
|
|
```bash
|
|
# Backup database
|
|
docker-compose exec db pg_dump -U wikijs wiki > backup_$(date +%Y%m%d).sql
|
|
|
|
# Backup uploaded files
|
|
tar -czf assets_backup_$(date +%Y%m%d).tar.gz data/assets/
|
|
```
|
|
|
|
### Restore
|
|
```bash
|
|
# Restore database
|
|
docker-compose exec -T db psql -U wikijs wiki < backup_YYYYMMDD.sql
|
|
|
|
# Restore uploaded files
|
|
tar -xzf assets_backup_YYYYMMDD.tar.gz
|
|
```
|
|
|
|
## 🔒 Security Considerations
|
|
|
|
1. **Change default passwords**: The setup script generates a secure database password automatically
|
|
2. **Firewall**: Consider restricting access to port 3000 to your local network only
|
|
3. **HTTPS**: For production use, set up a reverse proxy with SSL/TLS
|
|
4. **Regular updates**: Keep Docker images updated with `docker-compose pull`
|
|
|
|
## 🌐 Accessing from Other Devices
|
|
|
|
To access your wiki from other devices on your network:
|
|
|
|
1. Find your server's IP address: `ip addr show`
|
|
2. Update the `WIKI_URL` in `.env` to use your server's IP
|
|
3. Access via `http://YOUR_SERVER_IP:3000`
|
|
|
|
## 📚 Wiki.js Features
|
|
|
|
Your personal wiki includes:
|
|
|
|
- **Rich Text Editor**: WYSIWYG and Markdown support
|
|
- **Media Management**: Upload and organize images, documents, videos
|
|
- **Search**: Full-text search across all content
|
|
- **User Management**: Create accounts for family members or team
|
|
- **Themes**: Light and dark mode support
|
|
- **Mobile Friendly**: Responsive design for all devices
|
|
- **Version History**: Track changes to all pages
|
|
- **Categories & Tags**: Organize content efficiently
|
|
|
|
## 🆘 Troubleshooting
|
|
|
|
### Wiki won't start
|
|
```bash
|
|
# Check logs
|
|
docker-compose logs
|
|
|
|
# Restart services
|
|
docker-compose down
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Database connection issues
|
|
```bash
|
|
# Reset database
|
|
docker-compose down
|
|
docker volume rm wikiaodh_db-data
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Permission issues
|
|
```bash
|
|
# Fix permissions
|
|
sudo chown -R $USER:$USER data/
|
|
chmod -R 755 data/
|
|
```
|
|
|
|
## 🔄 Updates
|
|
|
|
To update Wiki.js to the latest version:
|
|
|
|
```bash
|
|
docker-compose down
|
|
docker-compose pull
|
|
docker-compose up -d
|
|
```
|
|
|
|
## 📞 Support
|
|
|
|
- [Wiki.js Documentation](https://docs.js.wiki/)
|
|
- [Wiki.js GitHub](https://github.com/Requarks/wiki)
|
|
- [Docker Compose Documentation](https://docs.docker.com/compose/)
|
|
|
|
---
|
|
|
|
**Enjoy your personal wiki! 📖✨**
|