isle.chat

A ssh powered chat server with public and private (invite-only) channels

Each channel has an owner who can change its banner and invite users (anyone can join if its public)

Demo it with ssh [email protected]

This project is very new right now so don't rely on it for anything critical

For now the code is all in one file, main.go, but I'm planning on cleaning it up and splitting it up, especially the command logic

Built using the charm bubbletea/wish stack

Features

• Users can create their own channels and make them public or private. They can invite users and change the banner (20x10 character) of their channel which shows on the right.
• Messages and accounts are persistent and stored on the database. SSH in from anywhere with your credentials and catch up with what you've missed
• Who's online? A member list on the right shows online users and in private channels also shows offline users
• Discord/slack style interface with channels on the left, chat in the middle and users on the right
• Channels with new messages show on the channel list on the left with the number of unread messages
• Set your timezone to see correct dates on messages (Persists across sessions). Timezones are initially set based on your ip

For news and help join the discord server: https://discord.gg/q35CTJvngp

Self-hosting

You can either build the binary yourself using go build or you can use docker.

docker run -t -i -p 2222:2222 -e CLICOLOR_FORCE=1 -e COLORTERM=truecolor -e TERM=xterm-256color --tmpfs /tmp -v ./ssh_keys/id_ed25519:/home/islechat/app/.ssh/id_ed25519:ro -v ./config.toml:/home/islechat/config.toml ashfn0/islechat

Additonally a docker-compose file is in this repository. The format of the config.toml file is:

Host = "0.0.0.0"
Port = "2222"
ServerName = "isle.chat" # Name of the server
AdminUsername = "admin" # Admin's username (Can post in the announcement channel)
BotUsername = "islebot" # Username of the bot for system messages
GlobalBanner = "banner" # Banner used for the #global channel
AnnouncementChannel = "news" # Name of read-only announcement channel
DefaultBanner = "banner" # Default banner for new channels
WelcomeMessage = "A new user joined for the first time! Welcome @%s. Run /help for information" # Message sent when a user joins. %s is the username of the user
FilterPublicMessages = false # Whether or not public messages should be filtered for profanity
RegistrationHeader = "isle.chat registration   " # Text shown at top of registration page
DatabaseMode = "sqlite" # Either sqlite or postgres
PostgresHost = "postgres"
PostgresUser = "islechat"
PostgresPassword = "password"
PostgresDBName = "islechat"
PostgresPort = "5432"
PostgresSSL = "disable"

SSH key

SSH key is used from the path: .ssh/id_ed25519" (They will be auto created if you dont specify one).

If you want ip based timezone detection to work you need to download GeoLite2-City.mmdb from the website (You just have to make an account its free) and update it every now and then

 Why use this?

• Communicate with friends in separated channels
• Connect from anywhere with your credentials (ssh is installed everywhere)

Commands:

• /chan create
• /chan public
• /chan private
• /chan invite
• /chan uninvite
• /chan join
• /chan leave
• /chan banner
• /tz

Features I'm working on adding:

• Support for adding your pubkey for authentication alongside user/pass
• Better channel ownership and moderation tools, for example having moderators and a simple permissions system

Features I'd like to add in the future:

• Friend requests/direct messages
• More customization like theming and username colors
• Connection to external authentication providers, for example LDAP
• Custom bot/command support