Troubleshooting
The problems people actually hit, most common first.
The toolbar does not appear#
- Is it tucked away? On a desktop the toolbar tucks off the right edge until you move the pointer there. On a phone it is along the bottom of the screen and does not tuck.
- Is it tucked away? Move the pointer to the right edge of the window.
- Open the browser console (⌥ ⌘ J in Chrome, ⌥ ⌘ C in Safari). Notefix prints a clear message when its files are blocked. The usual cause is the site's Content Security Policy: see Install options.
- Does the file load? Open
https://your-site.com/notefix/notefix-embed.jsdirectly. If that is a 404, the folder is not where the tag says.
Other people cannot see my notes#
- The tag needs
data-api. Without it, notes stay in each person's browser. - Open
https://your-site.com/notefix-api/health. It should show{"ok": true, ...}. If not, the proxy is not set up; see step 2. - Everyone must be on the same board. Set
data-boardso every page agrees, and make sure the name is in the store'sNOTES_BOARDS.
A deleted note came back#
Someone had the page open from before the delete, and it was not deleted through Notefix. Always delete from the note's card, never by editing the database: Notefix remembers what was deleted, so an old copy in someone's browser cannot bring it back.
Create an issue says nothing is connected#
The tag is missing data-issues="queue". See How connections work.
A note says QUEUED and never gets a ticket#
The note is waiting, but no connector picked it up.
- Is the connector running?
systemctl status notefix-github(or-jira,-trello). - Look at its log:
journalctl -u notefix-github -n 50. Problems with the token or the repository are stated there in plain words. NOTEFIX_BOARDmust be the same board asdata-boardon the page.- The note was sent to a tracker that is not running. Settings shows which trackers are running; start that one.
HTTP Error 403: Forbiddenin the log:NOTEFIX_SECRETdoes not match the store'sNOTES_CONNECTOR_SECRET.
Settings says Problem or Stopped#
Open Settings → Connected tools and point at the row.
- Stopped: the connector or notifier is not running.
systemctl status notefix-github(or-jira,-trello,-notify) says why, andjournalctl -u notefix-github -n 50shows its last words. - Problem, the key stopped working: the token expired or was revoked. Make a new one (GitHub, Jira, Trello), put it in the settings file, and restart the service.
- Problem, cannot find where it sends things: the repository, project or board was renamed or deleted, or the token's account lost access to it.
- Problem, not answering: the service is down or unreachable from your server. It keeps trying; nothing is lost.
- Slack or email missing entirely: the notifier needs
NOTEFIX_SECRETto report in. Without it, messages still go out, but Settings cannot show them.
Settings catches up within a minute of a fix.
The ticket was closed, but the note is still open#
- The connector checks tickets once a minute. Wait a moment.
- Trello: the card must be in a list named in
TRELLO_DONE_LISTS(Doneby default), or archived. - Jira: the status must be in Jira's Done category. A custom status like Ready for QA is usually In progress.
- Only tickets the connector filed itself are checked.
Slack or email sends nothing#
- The first run sends nothing on purpose. Leave a new note after it has started.
- A note must stay unchanged for 30 seconds, then changes are gathered for up to 90 more. Wait two minutes.
- Run once with
NOTEFIX_DRY_RUN=1to see what it would send. - Email: it refuses to send without
NOTEFIX_SECRETandNOTEFIX_PUBLIC_API, and says so when it starts. - Emails in spam: the
Fromdomain needs SPF and DKIM set up with your mail service.
The email field is not in Settings#
It only appears while a notifier with email set up is running for that board. That way nobody is offered emails that would never arrive.
The store will not start#
| It says | What to do |
|---|---|
… was written by a newer version of Notefix | You started an older version on a newer database. Start the newer version, or restore a backup taken before upgrading |
NOTES_BOARDS: 'x' is not a board name | Board names are letters, digits, - and _ |
Address already in use | Something else is on port 8097. Stop it, or set NOTES_PORT |
NOT imported x: x.json could not be read | An old board file is damaged. Fix or move it, and start again. Nothing was lost |
Notes do not move when the page scrolls#
Your app scrolls inside a box rather than the window. Tell Notefix which box: see Apps that scroll inside a box.
Every note is filed under the same screen#
Your app does not change the address when the screen changes. Tell Notefix the screen's name: see Single page apps.