Websockets - Locally Hosted Alternative for Pusher (Now Free)

sylv38

Unfortunately, I can't use websockets extension because my shared host (Infomaniak) doesn't let me open a new port (only output direction can be opened, not input). I don't have any access to ssl certificate files neither, I can only export them manually from their manager, not sure it could work and certificates are renewed every 3 months (Let's Encrypt). Too bad 😢

The only thing I see would be to host something on a subdomain, but it would be totally separated from Flarum and probably difficult to develop.

ctml

Can someone point out my issue? I've included my composer.json required packages. The error doesn't actually specify that another extension requires this version of guzzle/psr7 but my .lock does have guzzle v7.X. I am guessing psr7 1.5 (that this requires) is from guzzle v6.X?

$ composer require kyrne/websocket --update-with-all-dependencies
Do not run Composer as root/super user! See https://getcomposer.org/root for details
Warning from https://repo.packagist.org: Support for Composer 1 is deprecated and some packages will not be available. You should upgrade to Composer 2. See https://blog.packagist.com/deprecating-composer-1-support/
Using version ^3.0 for kyrne/websocket
./composer.json has been updated
Loading composer repositories with package information
Warning from https://repo.packagist.org: Support for Composer 1 is deprecated and some packages will not be available. You should upgrade to Composer 2. See https://blog.packagist.com/deprecating-composer-1-support/
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Conclusion: don't install kyrne/websocket 3.0.4
    - Conclusion: don't install kyrne/websocket 3.0.3
    - Conclusion: don't install kyrne/websocket 3.0.2
    - Conclusion: don't install kyrne/websocket 3.0.1
    - Conclusion: don't install kyrne/websocket 3.0.0
    - Conclusion: don't install kyrne/websocket 3.0.4
    - Conclusion: don't install kyrne/websocket 3.0.3
    - Conclusion: don't install kyrne/websocket 3.0.2
    - Conclusion: don't install kyrne/websocket 3.0.1
    - Conclusion: remove guzzlehttp/psr7 2.0.0
    - Installation request for kyrne/websocket ^3.0 -> satisfiable by kyrne/websocket[3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4].
    - Conclusion: don't install guzzlehttp/psr7 2.0.0
    - kyrne/websocket 3.0.0 requires guzzlehttp/psr7 ^1.5 -> satisfiable by guzzlehttp/psr7[1.5.0, 1.5.1, 1.5.2, 1.6.0, 1.6.1, 1.7.0, 1.8.0, 1.8.1, 1.8.2].
    - Can only install one of: guzzlehttp/psr7[1.5.0, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.5.1, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.5.2, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.6.0, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.6.1, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.7.0, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.8.0, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.8.1, 2.0.0].
    - Can only install one of: guzzlehttp/psr7[1.8.2, 2.0.0].
    - Installation request for guzzlehttp/psr7 (locked at 2.0.0) -> satisfiable by guzzlehttp/psr7[2.0.0].

composer.json

    "require": {
        "afrux/forum-stats-widget": "*",
        "afrux/forum-widgets-core": "*",
        "afrux/news-widget": "*",
        "afrux/online-users-widget": "*",
        "afrux/top-posters-widget": "*",
        "antoinefr/flarum-ext-money": "*",
        "askvortsov/flarum-auto-moderator": "*",
        "askvortsov/flarum-checklist": "*",
        "askvortsov/flarum-discussion-templates": "*",
        "askvortsov/flarum-markdown-tables": "*",
        "askvortsov/flarum-moderator-warnings": "*",
        "askvortsov/flarum-rich-text": "*",
        "clarkwinkelmann/flarum-ext-author-change": "*",
        "clarkwinkelmann/flarum-ext-circle-groups": "*",
        "clarkwinkelmann/flarum-ext-follow-tags-prompt": "*",
        "clarkwinkelmann/flarum-ext-post-bookmarks": "*",
        "clarkwinkelmann/flarum-ext-who-read": "*",
        "davwheat/custom-sidenav-links": "*",
        "flarum/approval": "*",
        "flarum/bbcode": "*",
        "flarum/core": "^1.0",
        "flarum/emoji": "*",
        "flarum/flags": "*",
        "flarum/lang-english": "*",
        "flarum/likes": "*",
        "flarum/lock": "*",
        "flarum/markdown": "*",
        "flarum/mentions": "*",
        "flarum/nicknames": "*",
        "flarum/statistics": "*",
        "flarum/sticky": "*",
        "flarum/subscriptions": "*",
        "flarum/suspend": "*",
        "flarum/tags": "*",
        "fof/analytics": "*",
        "fof/bbcode-details": "*",
        "fof/bbcode-tabs": "*",
        "fof/best-answer": "*",
        "fof/default-group": "*",
        "fof/default-user-preferences": "*",
        "fof/drafts": "*",
        "fof/follow-tags": "*",
        "fof/formatting": "*",
        "fof/forum-statistics-widget": "*",
        "fof/gamification": "*",
        "fof/impersonate": "*",
        "fof/links": "*",
        "fof/masquerade": "*",
        "fof/merge-discussions": "*",
        "fof/moderator-notes": "*",
        "fof/nightmode": "*",
        "fof/pages": "*",
        "fof/polls": "*",
        "fof/pretty-mail": "*",
        "fof/prevent-necrobumping": "*",
        "fof/profile-image-crop": "*",
        "fof/reactions": "*",
        "fof/socialprofile": "*",
        "fof/split": "*",
        "fof/subscribed": "*",
        "fof/upload": "*",
        "fof/user-bio": "*",
        "fof/user-directory": "*",
        "fof/webhooks": "*",
        "ianm/follow-users": "*",
        "justoverclock/flarum-ext-keywords": "*",
        "justoverclock/flarum-ext-welcomebox": "*",
        "kyrne/whisper": "*",
        "maicol07/flarum-ext-sso": "*",
        "michaelbelgium/flarum-discussion-views": "*",
        "nearata/flarum-ext-embed-video": "*",
        "nearata/flarum-ext-internal-links-noreload": "*",
        "nearata/flarum-ext-no-self-likes": "*",
        "nearata/flarum-ext-tags-color-generator": "*",
        "the-turk/flarum-flamoji": "*",
        "the-turk/flarum-stickiest": "*",
        "therealsujitk/flarum-ext-gifs": "*",
        "v17development/flarum-blog": "*",
        "v17development/flarum-support": "^2.3",
        "v17development/flarum-user-badges": "*"
    }

clarkwinkelmann

ctml this seems to be a similar dependency triangle like https://discuss.flarum.org/d/24684-can-only-install-one-of-guzzlehttpguzzle

If you update to Composer v2, Composer will be able to solve the issue by itself (maybe will require the -W flag). Otherwise you can follow the instructions in the linked discussion but replace guzzlehttp/client with guzzlehttp/psr7 and 6/7 versions with 1/2 versions.

ctml

clarkwinkelmann

Thanks, looks like that did the trick!

However I am encountering a new issue, because I have extiverse configured as a repository for my extension(s) I am subscribed to, it is trying to download from there and complaining I do not have rights to do so. The extension from extiverse is still paid, and seems custom repositories are given priority in composer v2. I am sure it is a simple fix to set packagist higher up in priority, anyone run into this?

  - Downloading kyrne/websocket (3.0.4)
 1/1 [============================] 100%
Installation failed, reverting ./composer.json and ./composer.lock to their original content.


  [Composer\Downloader\TransportException]
  Invalid credentials for 'https://extiverse.com/composer/archive/kyrne/websocket/3.0.4.0.zip', aborting.

    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/maicol07/flarum-api-client"
        },
        {
            "type": "composer",
            "url": "https://extiverse.com/composer/"
        }
    ],

luceos

ctml the solution would be to remove the extension from extiverse as a premium one 😉

clarkwinkelmann

ctml luceos oh I completely missed the fact you weren't trying to get that package from Extiverse.

In the meantime this might help https://getcomposer.org/doc/articles/repository-priorities.md

The canonical option I wouldn't recommend, but at the bottom of the page there's an exclude key that's shown that could be used to temporarily not retrieve that specific package from Extiverse.

ctml

luceos
agreed it would be the best option.

clarkwinkelmann
thanks a lot, the exclude did the trick! might be useful to someone else here who uses composer v2 and has extiverse configured for premium extensions.

Websockets is working great now, very easy setup after installation and took less than 10 min. I think you'd probably only have trouble if you are not familiar with nginx/apache & ssl.

In terms of features it would be great to see integration with @SychO's new Online User Widget . I don't know if both sides would have to adjust for that, or if it can be done entirely via websockets extension.

matteocontrini

@Kyrne I've noticed that the frontend code references kyrne-websocket.admin.discussion_list.show_updates_text which actually doesn't exist because it's in forum.

Also, would it be possible to make the presence/typing feature an option? 😇 Not sure I want them...

Kyrne

You had to know this was coming:

3.1.1

Online users widget in 100% real-time! Requires Widget Core to work.
- Only users will show up but the list is viewable by all
- Note that this is a standalone widget, you do not need the Online Users Extension. Everything is inside this update
Allow guests to view typing indicators inside discussions
Fixed lack of color on placeholder avatar images
Fixed a translation issue
Other super exciting changes like moving files around

After updating please clear your Flarum Cache and restart the websocket server.

Tags for people that were interested @ctml @[deleted]

ctml

Kyrne You had to know this was coming:

Booyah! 🕺 Thanks a ton @Kyrne !

GreXXL

Kyrne really like the feature. Is it intentional that you cannot see yourself in the user online widget? As a guest you can see yourself online 🙂 Also if you have enabled websockets only for logged-in users the widget breaks for guests and shows always loading. Should be disabled then?

Additionally: would it be possible to include "and X guests" to show how many non-logged in users are online.

MikeJones

Kyrne dang... This is getting interesting been watching for a bit...

This hard to set up on an nginx server?

ctml

GreXXL "and X guests" to show how many non-logged in users are online

That would be ~~nice~~ sweet!

One small issue, when hovering the online users the username is shown rather than the display name. Won't affect all forums but for mine it does matter 🙂

Kyrne

3.2.0

Guest count will now show up on the online widget
Users can see themselves in the widget
Respect "disclose online" preference
- Will show up as a guest on the widget (increased guest count not visible from the user's end)
- Will not be shown in the "here now" discussion area
- Typing indicator will not be sent
Use display names globally
Increased time between ping/pong messages by 50% to reduce load
Updated nginx docs for new users

After updating please clear your cache and restart the websocket server

GreXXL Also if you have enabled websockets only for logged-in users the widget breaks for guests and shows always loading. Should be disabled then?

Correct, this option will need to be off for the widget to work.

Kyrne

I'll fix all this tonight 🙂

Wadera

It's leaking usernames which untick:

Allow others to see when I am online

They are still display in online widgets and in the discussions pages under currently reading section

matteocontrini

Wadera I noticed that too, I think there should also be an option to disable the feature completely, for privacy reasons. I disabled the extension in the meantime, unfortunately.

ctml

matteocontrini you mean disable the widget? If yes, you just go to the cute widget and disable it there

matteocontrini

ctml ah sorry, I was thinking about the presence thing in the discussion page, which I think has the same problem

GreXXL

matteocontrini you can at least hide it by restricting access to admins in permissions.

[deleted]

MikeJones Nope. Not at all. I can help you with that.

m4v3rick

MikeJones

Really not difficult. I could do it with a little help from @Kyrne . The tutorial on the extiverse site is quite easy to follow.

« Previous Page Next Page »