Setup guide
Your server is running. This guide covers everything from first login to processing your first images.
Register your admin account
A registration link was sent to your admin_email during deployment. Click it to create your account and set your password. The link expires after 7 days and can only be used once. Check your spam folder if you don't see it.
If you are running multiple AddaxAI servers, the link may open a cached version of the wrong server. If that happens, clear your browser cache and click the link again.
Configure server settings
When you first log in, you'll see some warnings about missing settings. That's expected. Click on any setting name in the warning to go straight to the right page.
Set the camera timezone to match your cameras.
Create a project
Once those are set, you can create your first project.
- Go to the home page and click
Add project - Enter a project name and optionally a description and image
- Select the country where the cameras of this project are
- If you deployed with SpeciesNet, add the species labels CSV. See SpeciesNet setup for how to make one
- Click
Create project
A project groups your cameras, images, and users together. You can create multiple projects for different study areas or camera networks. When opening the project, you can see the options and a data-hungry dashboard.
Add and connect cameras
Before adding cameras, check the camera requirements to make sure your camera type is supported.
- Open your project and go to the
Camerastab - Click
Add camera - Fill in the fields:
- Camera ID (required): must exactly match the camera ID embedded in the images and reports, otherwise they won't be linked. See camera requirements for details on how this ID is extracted.
- Remarks (optional): notes about the camera placement, angle, or anything else you want to remember.
- Custom fields (optional): click
Add fieldto add any extra metadata you want to track, like "Heading: South" or "Tree: Oak".
A camera is just hardware, so it has no name. The place a camera stands is a site, and sites carry the names you work with day to day. A site is created automatically from the camera GPS, and you can rename it on the Sites tab. See sites and cameras.
You can also import multiple cameras at once by clicking Import CSV.
Then configure your cameras to upload via FTPS. See camera requirements for the connection settings and troubleshooting tips.
Once connected, images will be picked up and processed automatically. Results show up in the web interface after a few seconds. If not, check the troubleshooting section in the camera requirements doc.
Taking a camera out of a project
Select the camera on the Cameras tab and choose Delete. The dialog gives two options.
- Retire, keep the data. The camera stays in the project as a retired camera. Its photos, labels, placements, health and service history stay, its current placement is closed at its last photo, and its open service tasks are removed. The Camera ID is free again, so you can register the same device in another project, or in this one, and it starts there with a clean history. This is the option for a camera that moves to another project, is stolen, or breaks.
- Delete the camera and all its data. Everything the camera recorded disappears, including the stored photo files. This cannot be undone.
A retired camera that still uploads is treated as an unknown camera until it is registered again.
Moving a camera to another project
A camera belongs to one project at a time, and its Camera ID cannot be registered twice while it is in service. To move a device:
- In the old project, select the camera on the
Camerastab, chooseDelete, and pickRetire, keep the data. The old project keeps every photo and all history of that camera, shown under a retired camera. - In the new project, add the camera with the same Camera ID, by hand or by CSV. It starts there with a clean history. Nothing changes on the camera itself; its next upload lands in the new project.
Photos do not move with the camera. The old project keeps what the camera recorded there, the new project collects what it records from now on.
If you add a Camera ID that is still in service elsewhere, the app refuses with Camera ID ... is already in use in project ... and names the project when you are a member of it. Retire it there first.
Invite users
You can invite other people to your projects. There are two project roles:
- Project admin can manage a specific project (cameras, users, settings)
- Project viewer has read-only access to a specific project and can set their own notifications
To invite someone (project admins and server admins only):
- Open the project, go to
Admin toolsin the sidebar, thenUsers - Enter their email address and select a role
- They'll receive an invitation email with a registration link
Users can have different roles across different projects. For example, someone can be an admin of one project and a viewer of another.
To add a server admin (full access to all projects and system settings), go to Server admins in the hamburger menu on the projects page.
Set up notifications
Users can configure their notification preferences in the project settings.
Email reports
Email notifications (daily/weekly/monthly reports, battery alerts, system health, etc.) work out of the box using the SMTP settings from deployment.
Telegram alerts
There are two steps to get Telegram working:
Server admin: set up the bot
Go to Server settings, click Configure bot, and follow the instructions in the modal.
Each user: link their account
Go to the Notifications page in any project, click the Telegram link button, and follow the instructions in the modal.
Once linked, users pick which species they want instant Telegram alerts for in their project notification settings. They can also limit the alerts to certain sites, so you only hear about the places you care about.
The link is per project, so link once in every project you want alerts from. Several projects can use the same Telegram chat; every alert names its project, and the bot says which project each link is for.
Messages stopped after a new phone? If you deleted the bot chat on your old phone, or Telegram now runs under a new number, the server can no longer reach you. Go to the Notifications page, click Link again next to the Telegram row, and follow the modal once more. Unlink stops Telegram messages without linking a new account.
You're all set
Once images start flowing in, your dashboards, maps, and galleries will fill up. Happy monitoring!
If you have any questions, let me know: peter@addaxdatascience.com