Update documentation and add gitignore

- Document server configuration and SSHFS mount

- Add .gitignore to exclude mounts directory

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Sven Olderaan 2025-03-16 12:29:09 +01:00
parent 53db325bb2
commit 0e532e81f4
2 changed files with 42 additions and 1 deletions

22
.gitignore vendored Normal file

@ -0,0 +1,22 @@
# Ignore mounted directories
mounts/
# Ignore fonts directory
fonts/
# Node modules
node_modules/
# IDE files
.vscode/
.idea/
# Logs
*.log
# OS generated files
.DS_Store
Thumbs.db
# PHP temp files
*.swp

@ -34,4 +34,23 @@
### Extension Settings
- Store settings in `extension_settings[extensionName]`
- Allow configuration of image service URL
- Support style parameters (e.g., bubble style, colors)
- Support style parameters (e.g., bubble style, colors)
## Server Configuration
### SSHFS Mount
- Remote server mounted at `/home/crystal/Projects/SillyBubble/mounts/calista`
- Mount command: `sshfs calista@calista.the.sexiest.cat:/var/www/calista.the.sexiest.cat/ /home/crystal/Projects/SillyBubble/mounts/calista`
- Verify connection: `ls -la /home/crystal/Projects/SillyBubble/mounts/calista`
- Common mount error: If "Transport endpoint is not connected", run `fusermount -u /home/crystal/Projects/SillyBubble/mounts/calista` and try mounting again
### Deploying to Web Server
- Copy files to mounted directory: `cp /home/crystal/Projects/SillyBubble/image.php /home/crystal/Projects/SillyBubble/mounts/calista/`
- Create fonts directory if needed: `mkdir -p /home/crystal/Projects/SillyBubble/mounts/calista/fonts`
- Web server URL: `http://calista.the.sexiest.cat/image.php`
- Required server dependencies: PHP with GD library (`php-gd` package)
### Testing the Image Generator
- Direct test: `http://calista.the.sexiest.cat/image.php?q=Test%20message`
- HTML interface: `http://calista.the.sexiest.cat/sillybubble.html`
- Configure SillyBubble extension to use `http://calista.the.sexiest.cat/image.php` as the image service URL