{{define "index"}} About BareRTC

About BareRTC

This chat room software is called BareRTC and this page contains information about the software and how to use it.

BareRTC is an open source project released under the GNU General Public License with code available here.

About {{AsHTML .Config.Title}}

{{AsHTML .Config.Title}} is the name of this particular BareRTC server. The administrator may have left some links to more info below:


Help & Support

Tour of the user interface

Screenshot of the user interface on desktop
Pictured: Screenshot of the user interface on tablet or desktop-sized screens.

Screenshot of the user interface on mobile
Pictured: Screenshot of the mobile interface

Above are screenshots of how the chat room looks on desktop and mobile displays, respectively. For a description of some of the features pointed out above:

On mobile web browsers that don't have large enough screens to show everything at once, the Chat Room screen is shown by default and buttons appear in the corners to get to the two side panels (to change channels or manage your DMs, and to see Who Is Online and tune in to their webcams, respectively).


Feature Highlights

Emoji Reactions

You may add emoji reactions to chat messages by clicking on the button at the bottom right corner.

Reactions added by yourself or others will appear at the bottom of their message. You can see who reacted by hovering your mouse cursor over the button, or you can 'upvote' their reaction by clicking on it.

Muting spammy users

If somebody on chat is bothering you, you may mute their messages by clicking on the red button on their message.

While they are muted:

The mute is temporary and will last for the remainder of your chat session (until you log off).

Styling Your Messages

BareRTC supports Markdown syntax for your chat messages. You can make text bold by putting asterisks around part of it, **like this** or make text italic with *single asterisks*.

Hyperlinks you paste that begin with https:// will be clickable as-is, or you can create a custom label for it by typing e.g. [click my link](https://www.wikipedia.org/).

To learn more about Markdown, please check out the Markdown Guide website.


Video Sharing How-To's

About webcam sharing

The WebRTC technology used by this chat room allows for direct, peer to peer connections between you and the other chat members to stream video and audio directly to one another, without needing a server in the middle to relay all that data. In many cases, WebRTC should "just work" but you may run into trouble broadcasting if your local network is heavily firewalled (for example on a corporate or school network).

In many WebRTC video apps (such as Zoom, Jitsi, Google Hangouts, etc.), when one or both parties are on such difficult networks, a server in the middle is used to transfer the video data between them. BareRTC does not have any such server, as the bandwidth costs to carry your video could get expensive! If your video sharing is not working, it's unfortunate but you should still be able to have text chat conversations as normal.

Notice: because of the peer-to-peer nature of the webcam feature, it is possible that your chat partner may discover your IP address if they check their local computer's connections. This is true of all WebRTC-based video chat systems. Also, it is possible that your chat partner may "screen record" your video -- also true of all video sharing systems. Please inform a moderator if you know somebody is violating your privacy in this way so that they may be banned from the chat room.

How do I go on video?

To share your webcam, click on the green button at the top left of the web page. This will open a modal with some options for your camera:

How do I stop my camera?

When you are broadcasting, the red " Stop" button at the top of the page will turn your camera off.

How do I mute my camera's microphone?

The button to Mute will be at the top of the page next to the Stop button. Alternatively, you can click on the microphone inside your own webcam video preview to toggle the mute that way. Either button works!

How do I see who is watching me?

You may click on the button at the top of the page to see who is watching you. The number inside the button will be your current number of viewers.

You may also click on the Watching tab in the Who's Online list.

How do I stop somebody from watching me?

On the Who's Online list, click on the Watching tab to see who is currently watching your camera.

To 'boot' somebody off your camera, click on the button next to their name. This will kick them off your camera and they will not be allowed to re-open your cam for the remainder of your chat session.

To people who have been booted from your camera, the chat server will tell them that your camera isn't even broadcasting at all! They will see a greyed-out video button and may think you have simply turned off your camera, and they won't know for sure that you have booted them!

How do I make videos larger on my screen?

There are a few methods available to change the size of videos on the chat room, depending on whether your device has a mouse cursor or is a touch screen (such as a tablet).

Options that may work with all devices (with mouse or touch screen):

If you are on a device with a mouse cursor, such as a desktop or a laptop with a touchpad, there are a couple of ways to resize individual videos how you see fit:

And finally: you can put a video "full screen" too. In the control buttons at the bottom of each video (beginning with the mute audio button), the one on the right will toggle the video into a full screen view.


Supported Browsers

All features of the chat room, including webcam sharing, should generally work on all current web browsers and devices (Firefox, all Chromium browsers including Google Chrome or Microsoft Edge, Safari, Androids and iPads).


Privacy

Some of the privacy considerations with this chat room include:


Troubleshooting

This section contains some troubleshooting advice for issues commonly experienced in the chat room.

Webcam Sharing

Permission Denied, or NotAllowedError

If you see an error message from ChatClient that says something like "Webcam error: Permission denied" or a "NotAllowedError," this section is for you.

The reason for this error is that your web browser did not grant access to your Camera and Microphone for the chat room to use. This may be because you accidentally clicked on the "Deny" button when your browser asked you for permission, or because your web browser itself does not have permission for these devices on your computer.

When you encounter this error, there are two places to look to resolve this:

  1. In your web browser's settings (e.g. in Google Chrome or Firefox), make sure that you are granting permission for your Camera and Microphone to the chat room's website ({{.Hostname}}).
  2. In your operating system's settings, ensure that your web browser itself has permission to use your Camera and Microphone. Notice: on recent Mac OS and Windows systems, your web browser might not have permission by default to access these devices!

Please see the following sections for in-depth guidance on where to look.

Notice: webcam sharing will require both your Camera and your Microphone permission - if either one is denied, webcam sharing will fail.

1. Check your web browser's permissions for {{.Hostname}}

Go into your web browser's settings, to the "Privacy" or "Permissions" section and verify that {{.Hostname}} has permissions to use your Camera and your Microphone. Or at the very least: make sure that these settings are not set to "Deny" for {{.Hostname}}.

For example, on Google Chrome:

Or for example, on Mozilla Firefox:

After changing your browser settings, exit and restart your web browser and log on to the chat room. When going on webcam, hopefully your browser should ask you for permission for your webcam and microphone: be sure to click on "Allow" when prompted.

If the change in your web browser's settings doesn't resolve the permission error, then check in your operating system's settings.

2. Check in your operating system's settings

For example, if you are on Mac OS:

Or for example, if you are on Windows 10 or Windows 11:

Other Webcam Errors

The most common error is a Permission Error as described above, but there are some less common error messages you may experience. Here is a short list of some of them:

Other possible errors should be uncommon. If this troubleshooting guide has not been helpful, try copying the error message into a search engine and find information online: all of the text following "Webcam error:" will be coming from your web browser, so relevant results may be found online. A possible place to start may be the Mozilla documentation for getUserMedia.

Other peoples' webcams don't load

It may sometimes happen that you clicked to watch somebody else's webcam on chat, and their video doesn't load. If it only happens with some cameras (but other cameras load correctly), then the problem is most likely on that person's side and not your own: their camera likely doesn't work for anybody else who is trying to watch it, either.

Webcam sharing on the chat room works by "peer to peer" direct connections between chatters. Usually, this tends to "just work" for most people, but sometimes your network connection or firewall can get in the way and prevent a connection from being established.

The most common kinds of network conditions that cause problems connecting to webcams include:

For some specific advice:

{{end}}