README
¶
TmpChat - A Temporary Web Chat Application
TmpChat is a lightweight, real-time web chat application built with Go and WebSockets, designed to be easily deployed using Caddy web server. It provides a simple and clean interface for users to join chat rooms and communicate in real-time.
Features
- Real-time messaging using WebSockets
- User presence (shows when users join/leave)
- Online user count
- Responsive design that works on desktop and mobile
- Simple deployment with Caddy
- No database required - all data is stored in memory
Prerequisites
- Go 1.24 or higher
- Caddy v2
Deployment
-
Build with xcaddy:
xcaddy build --with github.com/jxskiss/caddy-tmpchat -
Edit your Caddyfile to configure tmpchat:
yourdomain.com { route /chat { tmpchat } } -
Run Caddy:
caddy run --config Caddyfile
Open https://yourdomain.com/chat to start chatting!
License
This project is open source and available under the MIT License.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Documentation
¶
Index ¶
- Constants
- type ChatServer
- type Client
- type Message
- type TempChat
- func (TempChat) CaddyModule() caddy.ModuleInfo
- func (p *TempChat) Cleanup() error
- func (p *TempChat) Provision(ctx caddy.Context) error
- func (p *TempChat) ServeHTTP(w http.ResponseWriter, r *http.Request, _ caddyhttp.Handler) error
- func (p *TempChat) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
- func (p *TempChat) Validate() error
Constants ¶
const ( MsgTypeOnline = "online" MsgTypeOffline = "offline" MsgTypeChat = "chat" MsgTypeSystem = "system" )
Message type constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChatServer ¶
type ChatServer struct {
// contains filtered or unexported fields
}
ChatServer maintains the set of active clients and broadcasts messages to all clients
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a connected user
type Message ¶
type Message struct {
Type string `json:"type"`
Content string `json:"content,omitempty"`
Username string `json:"username,omitempty"`
Timestamp int64 `json:"timestamp,omitempty"`
OnlineNum int `json:"online_num"`
}
Message structure
type TempChat ¶
type TempChat struct {
// contains filtered or unexported fields
}
func (TempChat) CaddyModule ¶
func (TempChat) CaddyModule() caddy.ModuleInfo
CaddyModule returns the Caddy module information.
func (*TempChat) UnmarshalCaddyfile ¶
UnmarshalCaddyfile implements caddyfile.Unmarshaler.
Source Files
Directories