major lander upgrades and somme udpates to documentionat
This commit is contained in:
53
mkdocs/docs/services/gitea.md
Normal file
53
mkdocs/docs/services/gitea.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Gitea
|
||||
|
||||
Self-hosted Git service for collaborative development.
|
||||
|
||||
## Overview
|
||||
|
||||
Gitea is a lightweight, self-hosted Git service similar to GitHub, GitLab, and Bitbucket. It provides a web interface for managing repositories, issues, pull requests, and more.
|
||||
|
||||
## Features
|
||||
|
||||
- Git repository hosting
|
||||
- Web-based interface
|
||||
- Issue tracking
|
||||
- Pull requests
|
||||
- Wiki and code review
|
||||
- Lightweight and easy to deploy
|
||||
|
||||
## Access
|
||||
|
||||
- **Default Web Port**: `${GITEA_WEB_PORT:-3030}` (default: 3030)
|
||||
- **Default SSH Port**: `${GITEA_SSH_PORT:-2222}` (default: 2222)
|
||||
- **URL**: `http://localhost:${GITEA_WEB_PORT:-3030}`
|
||||
- **Default Data Directory**: `/data/gitea`
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
- `GITEA__database__DB_TYPE`: Database type (e.g., `sqlite3`, `mysql`, `postgres`)
|
||||
- `GITEA__database__HOST`: Database host (default: `${GITEA_DB_HOST:-gitea-db:3306}`)
|
||||
- `GITEA__database__NAME`: Database name (default: `${GITEA_DB_NAME:-gitea}`)
|
||||
- `GITEA__database__USER`: Database user (default: `${GITEA_DB_USER:-gitea}`)
|
||||
- `GITEA__database__PASSWD`: Database password (from `.env`)
|
||||
- `GITEA__server__ROOT_URL`: Root URL (e.g., `${GITEA_ROOT_URL}`)
|
||||
- `GITEA__server__HTTP_PORT`: Web port (default: 3000 inside container)
|
||||
- `GITEA__server__DOMAIN`: Domain (e.g., `${GITEA_DOMAIN}`)
|
||||
|
||||
### Volumes
|
||||
|
||||
- `gitea_data:/data`: Gitea configuration and data
|
||||
- `/etc/timezone:/etc/timezone:ro`
|
||||
- `/etc/localtime:/etc/localtime:ro`
|
||||
|
||||
## Usage
|
||||
|
||||
1. Access Gitea at `http://localhost:${GITEA_WEB_PORT:-3030}`
|
||||
2. Register or log in as an admin user
|
||||
3. Create or import repositories
|
||||
4. Collaborate with your team
|
||||
|
||||
## Official Documentation
|
||||
|
||||
For more details, visit the [official Gitea documentation](https://docs.gitea.com/).
|
||||
@@ -55,15 +55,18 @@ Homepage uses YAML configuration files located in `./configs/homepage/`:
|
||||
Homepage is pre-configured with all Changemaker Lite services:
|
||||
|
||||
### Essential Tools
|
||||
|
||||
- **Code Server** (Port 8888): VS Code in the browser
|
||||
- **Listmonk** (Port 9000): Newsletter & mailing list manager
|
||||
- **NocoDB** (Port 8090): No-code database platform
|
||||
|
||||
### Content & Documentation
|
||||
|
||||
- **MkDocs** (Port 4000): Live documentation server
|
||||
- **Static Site** (Port 4001): Built documentation hosting
|
||||
|
||||
### Automation & Data
|
||||
|
||||
- **n8n** (Port 5678): Workflow automation platform
|
||||
- **PostgreSQL** (Port 5432): Database backends
|
||||
|
||||
@@ -142,21 +145,25 @@ Homepage monitors Docker containers automatically when configured:
|
||||
### Common Issues
|
||||
|
||||
**Configuration not loading**: Check YAML syntax in configuration files
|
||||
|
||||
```bash
|
||||
docker logs homepage-changemaker
|
||||
```
|
||||
|
||||
**Icons not displaying**: Verify icon paths and file permissions
|
||||
|
||||
```bash
|
||||
ls -la ./assets/icons/
|
||||
```
|
||||
|
||||
**Services not reachable**: Verify network connectivity between containers
|
||||
|
||||
```bash
|
||||
docker exec homepage-changemaker ping service-name
|
||||
```
|
||||
|
||||
**Widget data not updating**: Check Docker socket permissions and container access
|
||||
|
||||
```bash
|
||||
docker exec homepage-changemaker ls -la /var/run/docker.sock
|
||||
```
|
||||
@@ -193,6 +200,7 @@ responsive:
|
||||
## Official Documentation
|
||||
|
||||
For comprehensive configuration guides and advanced features:
|
||||
|
||||
- [Homepage Documentation](https://gethomepage.dev/)
|
||||
- [GitHub Repository](https://github.com/gethomepage/homepage)
|
||||
- [Configuration Examples](https://gethomepage.dev/configs/)
|
||||
|
||||
98
mkdocs/docs/services/map.md
Normal file
98
mkdocs/docs/services/map.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# Map
|
||||
|
||||
Interactive map service for geospatial data visualization, powered by NocoDB and Leaflet.js.
|
||||
|
||||
## Overview
|
||||
|
||||
The Map service provides an interactive web-based map for displaying, searching, and analyzing geospatial data from a NocoDB backend. It supports real-time geolocation, adding new locations, and is optimized for both desktop and mobile use.
|
||||
|
||||
## Features
|
||||
|
||||
- Interactive map visualization with OpenStreetMap
|
||||
- Real-time geolocation support
|
||||
- Add new locations directly from the map
|
||||
- Auto-refresh every 30 seconds
|
||||
- Responsive design for mobile devices
|
||||
- Secure API proxy to protect credentials
|
||||
- Docker containerization for easy deployment
|
||||
|
||||
## Access
|
||||
|
||||
- **Default Port**: `${MAP_PORT:-3000}` (default: 3000)
|
||||
- **URL**: `http://localhost:${MAP_PORT:-3000}`
|
||||
- **Default Workspace**: `/app/public/`
|
||||
|
||||
## Configuration
|
||||
|
||||
All configuration is done via environment variables:
|
||||
|
||||
| Variable | Description | Default |
|
||||
|---------------------|------------------------------------|--------------|
|
||||
| `NOCODB_API_URL` | NocoDB API base URL | Required |
|
||||
| `NOCODB_API_TOKEN` | API authentication token | Required |
|
||||
| `NOCODB_VIEW_URL` | Full NocoDB view URL | Required |
|
||||
| `PORT` | Server port | 3000 |
|
||||
| `DEFAULT_LAT` | Default map latitude | 53.5461 |
|
||||
| `DEFAULT_LNG` | Default map longitude | -113.4938 |
|
||||
| `DEFAULT_ZOOM` | Default map zoom level | 11 |
|
||||
|
||||
### Volumes
|
||||
|
||||
- `./map/app/public`: Map public assets
|
||||
|
||||
## Usage
|
||||
|
||||
1. Access the map at `http://localhost:${MAP_PORT:-3000}`
|
||||
2. Search for locations or addresses
|
||||
3. Add or view custom markers
|
||||
4. Analyze geospatial data as needed
|
||||
|
||||
## NocoDB Table Setup
|
||||
|
||||
### Required Columns
|
||||
|
||||
- `geodata` (Text): Format "latitude;longitude"
|
||||
- `latitude` (Decimal): Precision 10, Scale 8
|
||||
- `longitude` (Decimal): Precision 11, Scale 8
|
||||
|
||||
### Form Fields (as seen in the interface)
|
||||
|
||||
- `First Name` (Text): Person's first name
|
||||
- `Last Name` (Text): Person's last name
|
||||
- `Email` (Email): Contact email address
|
||||
- `Unit Number` (Text): Apartment/unit number
|
||||
- `Support Level` (Single Select):
|
||||
- 1 - Strong Support (Green)
|
||||
- 2 - Moderate Support (Yellow)
|
||||
- 3 - Low Support (Orange)
|
||||
- 4 - No Support (Red)
|
||||
- `Address` (Text): Full street address
|
||||
- `Sign` (Checkbox): Has campaign sign (true/false)
|
||||
- `Sign Size` (Single Select): Small, Medium, Large
|
||||
- `Geo-Location` (Text): Formatted as "latitude;longitude"
|
||||
|
||||
## API Endpoints
|
||||
|
||||
- `GET /api/locations` - Fetch all locations
|
||||
- `POST /api/locations` - Create new location
|
||||
- `GET /api/locations/:id` - Get single location
|
||||
- `PUT /api/locations/:id` - Update location
|
||||
- `DELETE /api/locations/:id` - Delete location
|
||||
- `GET /health` - Health check
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- API tokens are kept server-side only
|
||||
- CORS is configured for security
|
||||
- Rate limiting prevents abuse
|
||||
- Input validation on all endpoints
|
||||
- Helmet.js for security headers
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- Ensure NocoDB table has required columns and valid coordinates
|
||||
- Check API token permissions and network connectivity
|
||||
|
||||
## Official Documentation
|
||||
|
||||
Refer to the [project README](../../map/README.md) for more information.
|
||||
40
mkdocs/docs/services/mini-qr.md
Normal file
40
mkdocs/docs/services/mini-qr.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Mini QR
|
||||
|
||||
Simple QR code generator service.
|
||||
|
||||
## Overview
|
||||
|
||||
Mini QR is a lightweight service for generating QR codes for URLs, text, or other data. It provides a web interface for quick QR code creation and download.
|
||||
|
||||
## Features
|
||||
|
||||
- Generate QR codes for text or URLs
|
||||
- Download QR codes as images
|
||||
- Simple and fast interface
|
||||
- No user registration required
|
||||
|
||||
## Access
|
||||
|
||||
- **Default Port**: `${MINI_QR_PORT:-8089}` (default: 8089)
|
||||
- **URL**: `http://localhost:${MINI_QR_PORT:-8089}`
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
- `QR_DEFAULT_SIZE`: Default size of generated QR codes
|
||||
- `QR_IMAGE_FORMAT`: Image format (e.g., `png`, `svg`)
|
||||
|
||||
### Volumes
|
||||
|
||||
- `./configs/mini-qr`: QR code service configuration
|
||||
|
||||
## Usage
|
||||
|
||||
1. Access Mini QR at `http://localhost:${MINI_QR_PORT:-8089}`
|
||||
2. Enter the text or URL to encode
|
||||
3. Download or share the generated QR code
|
||||
|
||||
## Official Documentation
|
||||
|
||||
See the [project README](../../README.md) for more details.
|
||||
@@ -57,27 +57,32 @@ n8n is a powerful workflow automation tool that allows you to connect various ap
|
||||
## Common Use Cases
|
||||
|
||||
### Documentation Automation
|
||||
|
||||
- Auto-generate documentation from code comments
|
||||
- Sync documentation between different platforms
|
||||
- Notify team when documentation is updated
|
||||
|
||||
### Email Campaign Integration
|
||||
|
||||
- Connect Listmonk with external data sources
|
||||
- Automate subscriber management
|
||||
- Trigger campaigns based on events
|
||||
|
||||
### Database Management with NocoDB
|
||||
|
||||
- Sync data between NocoDB and external APIs
|
||||
- Automate data entry and validation
|
||||
- Create backup workflows for database content
|
||||
- Generate reports from NocoDB data
|
||||
|
||||
### Development Workflows
|
||||
|
||||
- Auto-deploy documentation on git push
|
||||
- Sync code changes with documentation
|
||||
- Backup automation
|
||||
|
||||
### Data Processing
|
||||
|
||||
- Process CSV files and import to databases
|
||||
- Transform data between different formats
|
||||
- Schedule regular data updates
|
||||
@@ -85,16 +90,19 @@ n8n is a powerful workflow automation tool that allows you to connect various ap
|
||||
## Example Workflows
|
||||
|
||||
### Simple Webhook to Email
|
||||
|
||||
```
|
||||
Webhook → Email
|
||||
```
|
||||
|
||||
### Scheduled Documentation Backup
|
||||
|
||||
```
|
||||
Schedule → Read Files → Compress → Upload to Storage
|
||||
```
|
||||
|
||||
### Git Integration
|
||||
|
||||
```
|
||||
Git Webhook → Process Changes → Update Documentation → Notify Team
|
||||
```
|
||||
@@ -110,6 +118,7 @@ Git Webhook → Process Changes → Update Documentation → Notify Team
|
||||
## Integration with Other Services
|
||||
|
||||
n8n can integrate with all services in your Changemaker Lite setup:
|
||||
|
||||
- **Listmonk**: Manage subscribers and campaigns
|
||||
- **PostgreSQL**: Read/write database operations
|
||||
- **Code Server**: File operations and git integration
|
||||
@@ -139,6 +148,7 @@ docker exec -it n8n-changemaker sh
|
||||
## Official Documentation
|
||||
|
||||
For comprehensive n8n documentation:
|
||||
|
||||
- [n8n Documentation](https://docs.n8n.io/)
|
||||
- [Community Workflows](https://n8n.io/workflows/)
|
||||
- [Node Reference](https://docs.n8n.io/integrations/builtin/)
|
||||
|
||||
@@ -34,6 +34,7 @@ NocoDB is an open-source no-code platform that transforms any database into a sm
|
||||
### Database Backend
|
||||
|
||||
NocoDB uses a dedicated PostgreSQL instance (`root_db`) with the following configuration:
|
||||
|
||||
- **Database Name**: `root_db`
|
||||
- **Username**: `postgres`
|
||||
- **Password**: `password`
|
||||
@@ -56,16 +57,19 @@ NocoDB uses a dedicated PostgreSQL instance (`root_db`) with the following confi
|
||||
## Common Use Cases
|
||||
|
||||
### Content Management
|
||||
|
||||
- Create content databases for blogs and websites
|
||||
- Manage product catalogs and inventories
|
||||
- Track customer information and interactions
|
||||
|
||||
### Project Management
|
||||
|
||||
- Task and project tracking systems
|
||||
- Team collaboration workspaces
|
||||
- Resource and timeline management
|
||||
|
||||
### Data Collection
|
||||
|
||||
- Custom forms for surveys and feedback
|
||||
- Event registration and management
|
||||
- Lead capture and CRM systems
|
||||
@@ -131,16 +135,19 @@ Application settings and metadata are stored in the `nc_data` volume.
|
||||
### Common Issues
|
||||
|
||||
**Service won't start**: Check if the PostgreSQL database is healthy
|
||||
|
||||
```bash
|
||||
docker logs root_db
|
||||
```
|
||||
|
||||
**Database connection errors**: Verify database credentials and network connectivity
|
||||
|
||||
```bash
|
||||
docker exec nocodb nc_data nc
|
||||
```
|
||||
|
||||
**Performance issues**: Monitor resource usage and optimize queries
|
||||
|
||||
```bash
|
||||
docker stats nocodb root_db
|
||||
```
|
||||
@@ -148,6 +155,7 @@ docker stats nocodb root_db
|
||||
## Official Documentation
|
||||
|
||||
For comprehensive guides and advanced features:
|
||||
|
||||
- [NocoDB Documentation](https://docs.nocodb.com/)
|
||||
- [GitHub Repository](https://github.com/nocodb/nocodb)
|
||||
- [Community Forum](https://community.nocodb.com/)
|
||||
Reference in New Issue
Block a user