Repository navigation
First Time Setup
Welcome to MyGarage! This guide walks you through your first login and helps you add your first vehicle, service visit, and fuel entry.
After starting MyGarage for the first time, navigate to:
http://localhost:8686
Or if you're accessing remotely:
http://your-server-ip:8686
On first launch, MyGarage defaults to no authentication mode for easy initial setup.
No Authentication (Default):
⚠️ Development/testing only- Anyone with the URL can access your data
- No Authentication Enabled warning shown in Settings → System
- Do not use if exposed to the internet
Local Authentication:
- Traditional username/password
- JWT-based sessions
- Best for single-user or family deployments
- Enable in Settings → System
OIDC/SSO Authentication:
- Integrate with Authentik, Keycloak, Google, Azure AD, or any OIDC provider
- Single sign-on
- Best for multi-user deployments
- Configure in Settings → System → Configure OIDC
To enable local authentication:
- Visit Settings → System
- In the Authentication Mode card, click the Local tab, then Switch to local sign-in, and confirm. It takes effect at once
- Click Register here on the sign-in page that opens
- Create your first user account (it becomes the admin)
For detailed OIDC setup, see Authentication Guide.
- Click "Add Vehicle" from the dashboard
- Enter your 17-character VIN (Vehicle Identification Number)
- Example:
1HGBH41JXMN109186
- Example:
- Click "Decode VIN"
- MyGarage automatically fills in:
- Year
- Make
- Model
- Trim
- Displacement and cylinders
- Transmission
- Click "Next" and add the rest:
- Nickname (required; e.g., "Daily Driver", "Weekend Cruiser")
- Vehicle Type (required)
- License Plate
- Color
- Purchase Date
- Purchase Price
- Upload a photo (optional but recommended)
- Click "Create Vehicle"
If your VIN doesn't decode (older vehicles, motorcycles, etc.):
- Click "Add Vehicle"
- Enter the VIN and click "Next" without decoding
- Fill in vehicle details:
- Nickname (required)
- Vehicle Type (required)
- Year, make, model, trim, color, etc. (optional)
- Click "Next" to the end, then "Create Vehicle"
Once you've added a vehicle:
- Click on the vehicle card from the dashboard
- Open the Maintenance tab, then Service
- Click Log Service Visit
- Fill in the visit details:
- Date - When was the service performed?
- Mileage - The odometer reading
- Vendor/Shop - "Jiffy Lube", "DIY", or search for saved vendors
- Add line items (one per service performed) with Add Item:
- Category - Maintenance
- Description - "Oil change - Mobil 1 synthetic 5W-30"
- Cost - $45.99
- Add tax and fees (optional):
- Tax, Shop Supplies, Misc Fees
- Click Create
To attach a receipt, edit the saved visit and upload it under Attachments (JPG, PNG, GIF or PDF, up to 10MB).
- Be consistent with odometer readings - This helps track mileage trends
- Attach receipts - Useful for warranty claims and resale value
- Include all line items - Match your receipt for accurate totals
- Set up maintenance schedule - MyGarage can remind you when service is due
Track fuel economy and fill-up history:
- Click on your vehicle from the dashboard
- Open the Fuel tab
- Click Add Fill-up
- Enter fill-up details:
- Date - When did you fill up?
- Mileage - The odometer reading
- Volume - How much fuel did you add?
- Price per - The price per gallon or litre, e.g. $3.45
- Total Cost - Auto-calculated from price, volume, and rebate
- Fueling station - "Shell", "Costco", etc.
- Full Tank Fill-up - Check if you filled to full (required for fuel economy)
- Click Create
- Mark full tanks accurately - Partial fills are fine; their fuel is folded into the next full tank's economy automatically
- Record odometer precisely - Accuracy matters for fuel economy calculations
- First fill-up won't show MPG - You need at least 2 fill-ups to calculate MPG
- Track consistently - The more data, the better your analytics
After adding your vehicle, the dashboard displays:
- Photo - Vehicle image (if uploaded)
- Nickname/Name - Quick identification
- Recent Activity - Last Service, Last Fill-up, Latest Odometer
- Fuel Economy - Average fuel economy
- View Details - Opens the vehicle
- Overdue and Upcoming (next 30 days) reminders
- Spent this year
- Next due reminder
Never miss an oil change or inspection:
- Go to your vehicle's detail page
- Open Tracking, then Reminders
- Click "Add Reminder"
- Configure reminder:
- Title - Oil Change, Tire Rotation, Inspection, etc.
- Reminder Type - Date, Mileage, Both, or Smart (Engine Hours for vehicles that track hours)
- For a mileage reminder, a Service interval (e.g., every 5,000 miles), counted from now or from the last service; MyGarage works out the target
- Click "Create"
MyGarage will display alerts on the dashboard when reminders are due.
Store registration, insurance, and owner's manuals:
- Go to your vehicle's detail page
- Open Media, then Documents
- Click "Upload Document"
- Choose the file (PDF, JPG, PNG, or office files) and enter a title
- Optionally select a Document Type:
- Insurance
- Registration
- Manual
- Receipt
- Inspection
- Other
- Click "Upload Document"
Now that you've set up your first vehicle, explore these features:
- Analytics - View fuel economy trends, spending over time, and service frequency charts
- Export Data - Backup your data as JSON or CSV
- Multi-Vehicle Comparison - Compare fuel economy and costs across vehicles
- Appearance - Light/dark toggle in the top bar; six accent colours under the gear icon → Quick settings
- Units, language, currency and time format - Also under the gear icon → Quick settings (see Units and Language & Translations)
- Authentication - Switch to local or OIDC mode for security (see Authentication)
- Troubleshooting - See Troubleshooting Guide
- FAQ - Common questions at FAQ
- Community Support - Ask questions on GitHub Discussions
- Bug Reports - Report issues on GitHub Issues
Next: Learn more about Managing Vehicles or dive into Service Visits.