Skip to content

Commit 8aba5be

Browse files
cdibonaclaude
andcommitted
Rename FerryTrmnl -> FerryNotifier throughout
The repo is FerryNotifier, but docs, deployment configs, the systemd units, and two on-page labels still said "FerryTrmnl" — including clone/remote URLs pointing at github.com/cdibona/FerryTrmnl, which 404s. Normalized every reference: FerryTrmnl -> FerryNotifier and ferrytrmnl -> ferrynotifier (service names, log/nginx paths, Docker user). Renamed the unit files to deployment/ferrynotifier.service and ferrynotifier-staging.service. The page header brand and e-ink preview footer now read "FerryNotifier"; the test that asserts the brand is on the page tracks the change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent a8176e1 commit 8aba5be

15 files changed

Lines changed: 178 additions & 178 deletions

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Contributing to FerryTrmnl
1+
# Contributing to FerryNotifier
22

3-
Thank you for your interest in contributing to FerryTrmnl! This document provides guidelines and instructions for contributing to the project.
3+
Thank you for your interest in contributing to FerryNotifier! This document provides guidelines and instructions for contributing to the project.
44

55
## Project Structure
66

77
```
8-
FerryTrmnl/
8+
FerryNotifier/
99
├── web/ # Web application code
1010
│ ├── app.py # Main Flask application
1111
│ ├── test_app.py # Unit tests
1212
│ └── requirements.txt # Python dependencies
1313
├── deployment/ # Deployment configurations
1414
│ ├── Dockerfile # Docker container definition
1515
│ ├── docker-compose.yml # Docker Compose configuration
16-
│ ├── ferrytrmnl.service # Systemd service file
16+
│ ├── ferrynotifier.service # Systemd service file
1717
│ ├── nginx.conf.example # Nginx reverse proxy config
1818
│ └── run.sh # Quick-start development script
1919
├── .github/
@@ -37,8 +37,8 @@ FerryTrmnl/
3737

3838
2. Clone your fork:
3939
```bash
40-
git clone https://github.com/YOUR_USERNAME/FerryTrmnl.git
41-
cd FerryTrmnl
40+
git clone https://github.com/YOUR_USERNAME/FerryNotifier.git
41+
cd FerryNotifier
4242
```
4343

4444
3. Create a virtual environment:
@@ -153,7 +153,7 @@ We welcome contributions in these areas:
153153

154154
1. **Update your fork** with the latest changes from main:
155155
```bash
156-
git remote add upstream https://github.com/cdibona/FerryTrmnl.git
156+
git remote add upstream https://github.com/cdibona/FerryNotifier.git
157157
git fetch upstream
158158
git rebase upstream/main
159159
```
@@ -228,10 +228,10 @@ Be mindful of WSDOT API rate limits during development. Consider:
228228
For testing Docker builds:
229229
```bash
230230
# Build from project root
231-
docker build -f deployment/Dockerfile -t ferrytrmnl .
231+
docker build -f deployment/Dockerfile -t ferrynotifier .
232232

233233
# Run container
234-
docker run -p 5050:5050 --env-file .env ferrytrmnl
234+
docker run -p 5050:5050 --env-file .env ferrynotifier
235235
```
236236

237237
## Documentation
@@ -273,4 +273,4 @@ If you have questions about contributing:
273273

274274
By contributing, you agree that your contributions will be licensed under the same license as the project (MIT License).
275275

276-
Thank you for contributing to FerryTrmnl!
276+
Thank you for contributing to FerryNotifier!

INSTALL.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,17 @@ sudo apt install -y python3 python3-pip python3-venv nginx git
7575
Create a directory for the application:
7676

7777
```bash
78-
sudo mkdir -p /opt/FerryTrmnl
79-
sudo chown $USER:$USER /opt/FerryTrmnl
78+
sudo mkdir -p /opt/FerryNotifier
79+
sudo chown $USER:$USER /opt/FerryNotifier
8080
```
8181

8282
## Step 3: Clone Repository
8383

84-
Clone the FerryTrmnl repository:
84+
Clone the FerryNotifier repository:
8585

8686
```bash
87-
cd /opt/FerryTrmnl
88-
git clone https://github.com/cdibona/FerryTrmnl.git .
87+
cd /opt/FerryNotifier
88+
git clone https://github.com/cdibona/FerryNotifier.git .
8989
```
9090

9191
## Step 4: Set Up Python Virtual Environment
@@ -152,60 +152,60 @@ curl http://localhost:5050/webhook
152152
Create log directory:
153153

154154
```bash
155-
sudo mkdir -p /var/log/ferrytrmnl
156-
sudo chown www-data:www-data /var/log/ferrytrmnl
155+
sudo mkdir -p /var/log/ferrynotifier
156+
sudo chown www-data:www-data /var/log/ferrynotifier
157157
```
158158

159159
Copy the systemd service file:
160160

161161
```bash
162-
sudo cp deployment/ferrytrmnl.service /etc/systemd/system/
162+
sudo cp deployment/ferrynotifier.service /etc/systemd/system/
163163
```
164164

165165
Edit the service file if needed (adjust paths, user, workers):
166166

167167
```bash
168-
sudo nano /etc/systemd/system/ferrytrmnl.service
168+
sudo nano /etc/systemd/system/ferrynotifier.service
169169
```
170170

171171
Set proper ownership:
172172

173173
```bash
174-
sudo chown -R www-data:www-data /opt/FerryTrmnl
174+
sudo chown -R www-data:www-data /opt/FerryNotifier
175175
```
176176

177177
Reload systemd and enable the service:
178178

179179
```bash
180180
sudo systemctl daemon-reload
181-
sudo systemctl enable ferrytrmnl
182-
sudo systemctl start ferrytrmnl
181+
sudo systemctl enable ferrynotifier
182+
sudo systemctl start ferrynotifier
183183
```
184184

185185
Check the service status:
186186

187187
```bash
188-
sudo systemctl status ferrytrmnl
188+
sudo systemctl status ferrynotifier
189189
```
190190

191191
View logs:
192192

193193
```bash
194-
sudo journalctl -u ferrytrmnl -f
194+
sudo journalctl -u ferrynotifier -f
195195
```
196196

197197
## Step 8: Configure Nginx
198198

199199
Copy the nginx configuration:
200200

201201
```bash
202-
sudo cp deployment/nginx.conf.example /etc/nginx/sites-available/ferrytrmnl
202+
sudo cp deployment/nginx.conf.example /etc/nginx/sites-available/ferrynotifier
203203
```
204204

205205
Edit the configuration file:
206206

207207
```bash
208-
sudo nano /etc/nginx/sites-available/ferrytrmnl
208+
sudo nano /etc/nginx/sites-available/ferrynotifier
209209
```
210210

211211
Replace `ferry.yourdomain.com` with your actual domain name.
@@ -221,7 +221,7 @@ sudo nginx -t
221221
Enable the site:
222222

223223
```bash
224-
sudo ln -s /etc/nginx/sites-available/ferrytrmnl /etc/nginx/sites-enabled/
224+
sudo ln -s /etc/nginx/sites-available/ferrynotifier /etc/nginx/sites-enabled/
225225
sudo systemctl reload nginx
226226
```
227227

@@ -277,10 +277,10 @@ curl https://ferry.yourdomain.com/api/ferry-status
277277

278278
```bash
279279
# Build the Docker image from project root
280-
docker build -f deployment/Dockerfile -t ferrytrmnl .
280+
docker build -f deployment/Dockerfile -t ferrynotifier .
281281

282282
# Run with .env file
283-
docker run -p 5050:5050 --env-file .env ferrytrmnl
283+
docker run -p 5050:5050 --env-file .env ferrynotifier
284284
```
285285

286286
Or use docker-compose:
@@ -311,25 +311,25 @@ docker-compose logs -f
311311

312312
```bash
313313
# Systemd logs
314-
sudo journalctl -u ferrytrmnl -f
314+
sudo journalctl -u ferrynotifier -f
315315

316316
# Application logs (if configured)
317-
sudo tail -f /var/log/ferrytrmnl/error.log
318-
sudo tail -f /var/log/ferrytrmnl/access.log
317+
sudo tail -f /var/log/ferrynotifier/error.log
318+
sudo tail -f /var/log/ferrynotifier/access.log
319319
```
320320

321321
### View Nginx Logs
322322

323323
```bash
324-
sudo tail -f /var/log/nginx/ferrytrmnl_access.log
325-
sudo tail -f /var/log/nginx/ferrytrmnl_error.log
324+
sudo tail -f /var/log/nginx/ferrynotifier_access.log
325+
sudo tail -f /var/log/nginx/ferrynotifier_error.log
326326
```
327327

328328
### Restart Services
329329

330330
```bash
331331
# Restart application
332-
sudo systemctl restart ferrytrmnl
332+
sudo systemctl restart ferrynotifier
333333

334334
# Restart nginx
335335
sudo systemctl restart nginx
@@ -341,11 +341,11 @@ sudo systemctl reload nginx
341341
### Update Application
342342

343343
```bash
344-
cd /opt/FerryTrmnl
344+
cd /opt/FerryNotifier
345345
git pull
346346
source venv/bin/activate
347347
pip install -r web/requirements.txt
348-
sudo systemctl restart ferrytrmnl
348+
sudo systemctl restart ferrynotifier
349349
```
350350

351351
## CI/CD Deployment
@@ -377,7 +377,7 @@ Configure these secrets in your GitHub repository settings:
377377

378378
Check logs:
379379
```bash
380-
sudo journalctl -u ferrytrmnl -n 50
380+
sudo journalctl -u ferrynotifier -n 50
381381
```
382382

383383
Common issues:
@@ -388,7 +388,7 @@ Common issues:
388388

389389
### Nginx 502 Bad Gateway
390390

391-
- Ensure ferrytrmnl service is running: `sudo systemctl status ferrytrmnl`
391+
- Ensure ferrynotifier service is running: `sudo systemctl status ferrynotifier`
392392
- Check if port 5050 is listening: `sudo netstat -tlnp | grep 5050`
393393
- Review nginx error logs
394394

@@ -410,11 +410,11 @@ Common issues:
410410

411411
### Adjust Gunicorn Workers
412412

413-
Edit `/etc/systemd/system/ferrytrmnl.service`:
413+
Edit `/etc/systemd/system/ferrynotifier.service`:
414414

415415
```ini
416416
# Formula: (2 x CPU cores) + 1
417-
ExecStart=/opt/FerryTrmnl/venv/bin/gunicorn --workers 4 ...
417+
ExecStart=/opt/FerryNotifier/venv/bin/gunicorn --workers 4 ...
418418
```
419419

420420
For a 2-core server: 5 workers
@@ -423,7 +423,7 @@ For a 4-core server: 9 workers
423423
After changes:
424424
```bash
425425
sudo systemctl daemon-reload
426-
sudo systemctl restart ferrytrmnl
426+
sudo systemctl restart ferrynotifier
427427
```
428428

429429
### Nginx Caching (Optional)
@@ -432,15 +432,15 @@ Add caching to nginx configuration to reduce load on WSDOT API:
432432

433433
```nginx
434434
# Add to http block in /etc/nginx/nginx.conf
435-
proxy_cache_path /var/cache/nginx/ferrytrmnl levels=1:2 keys_zone=ferrytrmnl_cache:10m max_size=100m inactive=60m use_temp_path=off;
435+
proxy_cache_path /var/cache/nginx/ferrynotifier levels=1:2 keys_zone=ferrynotifier_cache:10m max_size=100m inactive=60m use_temp_path=off;
436436
437437
# Add to location / block in your site config
438-
proxy_cache ferrytrmnl_cache;
438+
proxy_cache ferrynotifier_cache;
439439
proxy_cache_valid 200 10m;
440440
proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
441441
add_header X-Cache-Status $upstream_cache_status;
442442
```
443443

444444
## Support
445445

446-
For issues or questions, please visit the [GitHub repository](https://github.com/cdibona/FerryTrmnl).
446+
For issues or questions, please visit the [GitHub repository](https://github.com/cdibona/FerryNotifier).

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 FerryTrmnl Contributors
3+
Copyright (c) 2024 FerryNotifier Contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)