Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optional role for matrix-fluffygate #3677

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

ayushin
Copy link
Contributor

@ayushin ayushin commented Oct 24, 2024

No description provided.

Comment on lines 1 to 7
{
"active_provider": "claude.ai",
"active_organization_id": "4c1644e0-e630-48f7-bb87-4d8387ef9cd8",
"active_project_id": "1d6c1d5c-5270-439c-9885-aff7168cb24d",
"active_project_name": "matrix-fluffygate",
"local_path": "/Users/alexis/Work/witi/witi-matrix-ansible/roles/custom/matrix-fluffygate"
}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this.

Comment on lines +3 to +7
The playbook can install and configure [Fluffygate](https://github.com/krille-chan/fluffygate), a simple Push Gateway for Fluffychat.

See the project's documentation to learn what it does and why it might be useful to you.

**Note**: most people don't need to install their own gateway. This optional playbook component is only useful to people who develop/build their own Matrix client applications themselves, as you'll need access to your own Firebase/FCM and APNS credentials.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be useful to also mention Sygnal here (docs/configuring-playbook-sygnal.md) here and mention Fluffygate on the Sygnal docs page as well.

If this "mention" is also a brief comparison as to when one might use one or the other, it'd be even better. It seems like Sygnal is supports direct delivery via APNS , while Fluffygate only supports FCM? Maybe this makes setup easier as all platform-specific setup would happen on the FCM side?

Comment on lines +55 to +56
- `matrix_fluffygate_hostname`
- `matrix_fluffygate_path_prefix`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we consider automatically configuring matrix_fluffygate_hostname to point to matrix_server_fqn_matrix and matrix_fluffygate_path_prefix to be something like /fluffygate, etc?

This way we'll have a reasonable default.

Have you confirmed that hosting it under a path prefix works as expected?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll clean things up bit later - very little time these days, yet wanted to contribute to the upstream.

I tried hosting on the same host but that did not work for some reason and I went with a dedicated hostname instead. Can try again later.

@luixxiul
Copy link
Collaborator

luixxiul commented Nov 10, 2024

It would be great if you would add an entry about Fluffygate to README.md (around here) and container-images.md (around here). Adding a description about DNS change would also be nice (around here) 😃

And here as well…

Comment on lines +90 to +94
## Adjusting DNS records

You will need to configure your DNS records to point the Fluffygate hostname to your server. This typically involves creating either:
- an A record pointing to your server's IPv4 address
- a CNAME record pointing to your server's hostname
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per existing lines for Sygnal here.

Please update the default CNAME record push, when addressing the comment.

Suggested change
## Adjusting DNS records
You will need to configure your DNS records to point the Fluffygate hostname to your server. This typically involves creating either:
- an A record pointing to your server's IPv4 address
- a CNAME record pointing to your server's hostname
## Adjusting DNS records
Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Fluffygate domain to the Matrix server.
By default, you will need to create a CNAME record for `push`. See [Configuring DNS](configuring-dns.md) for details about DNS changes.
If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants