Update donetick/README.md
This commit is contained in:
parent
e8f91f1933
commit
9b818ab662
1 changed files with 119 additions and 23 deletions
|
|
@ -1,31 +1,127 @@
|
||||||
To set this up:
|
## A detailed Guide setting up the Donetick components in unRAID.
|
||||||
|
|
||||||
1. Create the necessary directories:
|
1. **Installation Setup**
|
||||||
|
- Open your unRAID dashboard
|
||||||
|
- Go to the "Apps" tab
|
||||||
|
- Click "Add Container" button
|
||||||
|
- Copy and paste the template we provided into the template field
|
||||||
|
|
||||||
|
2. **Path Configuration**
|
||||||
|
You'll need to verify/create these directories:
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /mnt/user/appdata/donetick/database
|
/mnt/user/appdata/Donetick/ # Main application directory
|
||||||
mkdir -p /mnt/user/appdata/donetick/config
|
/mnt/user/appdata/Donetick/config # Configuration files
|
||||||
|
/mnt/user/appdata/Donetick/database # SQLite database storage
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Create the selfhosted.yaml file:
|
3. **Port Configuration**
|
||||||
```bash
|
- Port 2021: Web interface access
|
||||||
nano /mnt/user/appdata/donetick/config/local.yaml
|
- Can be changed if this port conflicts with other services
|
||||||
```
|
- Default mapping: 2021 -> 2021 (internal)
|
||||||
Copy the YAML content from above into this file.
|
- Used for both API and frontend when serve_frontend is true
|
||||||
|
|
||||||
3. Set proper permissions:
|
4. **Environment Variables**
|
||||||
```bash
|
- `DT_ENV=local`
|
||||||
chmod -R 755 /mnt/user/appdata/donetick
|
- Determines which config file to use
|
||||||
chmod 644 /mnt/user/appdata/donetick/config/local.yaml
|
- Options: `local` or `selfhosted`
|
||||||
chown -R nobody:users /mnt/user/appdata/donetick
|
|
||||||
|
5. **Configuration Setup**
|
||||||
|
Place the appropriate YAML file in `/mnt/user/appdata/Donetick/config/`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# local.yaml or selfhosted.yaml structure
|
||||||
|
name: "local" # or "selfhosted"
|
||||||
|
is_done_tick_dot_com: false
|
||||||
|
telegram:
|
||||||
|
token: ""
|
||||||
|
database:
|
||||||
|
type: "sqlite"
|
||||||
|
migration: true
|
||||||
|
jwt:
|
||||||
|
secret: "your-secure-secret-here"
|
||||||
|
session_time: 168h
|
||||||
|
max_refresh: 168h
|
||||||
|
server:
|
||||||
|
port: 2021
|
||||||
|
read_timeout: 2s
|
||||||
|
write_timeout: 1s
|
||||||
|
rate_period: 60s
|
||||||
|
rate_limit: 300
|
||||||
|
cors_allow_origins:
|
||||||
|
- "http://localhost:5173"
|
||||||
|
- "http://localhost:7926"
|
||||||
|
serve_frontend: true # false for local.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Key points:
|
6. **Directory Structure**
|
||||||
1. Updated all paths to match the container's internal structure
|
```
|
||||||
2. Fixed the database path to use `/usr/src/app/data`
|
/mnt/user/appdata/Donetick/
|
||||||
3. Corrected the WebUI port to 2021
|
├── config/
|
||||||
4. Updated volume mappings to match the application's requirements
|
│ ├── local.yaml # Local configuration
|
||||||
|
│ └── selfhosted.yaml # Selfhosted configuration
|
||||||
|
└── database/
|
||||||
|
└── donetick.db # SQLite database file
|
||||||
|
```
|
||||||
|
|
||||||
Remember to:
|
7. **Permissions**
|
||||||
- Generate a secure random string for the `auth.jwt.secret` in selfhosted.yaml
|
```bash
|
||||||
- Double-check all paths match your Unraid setup
|
# Set correct permissions
|
||||||
- Ensure the selfhosted.yaml file is in place before starting the container
|
chmod -R 755 /mnt/user/appdata/Donetick
|
||||||
|
chmod 644 /mnt/user/appdata/Donetick/config/*.yaml
|
||||||
|
chown -R nobody:users /mnt/user/appdata/Donetick
|
||||||
|
```
|
||||||
|
|
||||||
|
8. **Backup Considerations**
|
||||||
|
Important directories to backup:
|
||||||
|
- `/mnt/user/appdata/Donetick/config`
|
||||||
|
- `/mnt/user/appdata/Donetick/database`
|
||||||
|
|
||||||
|
9. **Security Recommendations**
|
||||||
|
- Change default JWT secret in config file
|
||||||
|
- Use a strong, randomly generated string
|
||||||
|
- Consider configuring email notifications
|
||||||
|
- Update CORS settings if exposing to internet
|
||||||
|
- Configure rate limiting appropriately
|
||||||
|
|
||||||
|
10. **Troubleshooting Tips**
|
||||||
|
- Check container logs in unRAID dashboard
|
||||||
|
- Verify config file exists and is named correctly
|
||||||
|
- Common issues:
|
||||||
|
```bash
|
||||||
|
# Check if config file exists
|
||||||
|
ls -l /mnt/user/appdata/Donetick/config/
|
||||||
|
|
||||||
|
# Verify port availability
|
||||||
|
netstat -tuln | grep 2021
|
||||||
|
|
||||||
|
# Check config file permissions
|
||||||
|
ls -l /mnt/user/appdata/Donetick/config/*.yaml
|
||||||
|
|
||||||
|
# View container logs
|
||||||
|
docker logs donetick
|
||||||
|
```
|
||||||
|
|
||||||
|
11. **Additional Features Setup**
|
||||||
|
- Email Notifications:
|
||||||
|
```yaml
|
||||||
|
email:
|
||||||
|
host: "smtp.example.com"
|
||||||
|
port: "587"
|
||||||
|
key: "your-smtp-password"
|
||||||
|
email: "your@email.com"
|
||||||
|
appHost: "your-app-url"
|
||||||
|
```
|
||||||
|
|
||||||
|
- Telegram Integration:
|
||||||
|
```yaml
|
||||||
|
telegram:
|
||||||
|
token: "your-bot-token"
|
||||||
|
```
|
||||||
|
|
||||||
|
12. **Post-Installation Steps**
|
||||||
|
1. Access the web interface at: `http://[your-unraid-ip]:2021`
|
||||||
|
2. Set up your initial user account
|
||||||
|
3. Configure any additional notification settings
|
||||||
|
4. Test task creation and management
|
||||||
|
|
||||||
|
This should give you a comprehensive understanding of the Donetick setup process in unRAID.
|
||||||
Loading…
Reference in a new issue