Server Setup

Complete guide to setting up Clocky in your Discord server for the first time.

Prerequisites

Before adding Clocky to your server, ensure you have:

Adding Clocky to your server

Step 1: Get the invite link

Visit the Clocky installation page or use this direct link:

Step 2: Select your server

1. Click the invite link
2. A Discord authorization page will open
3. Select the server from the dropdown menu
4. Important: Make sure you select the correct server!

Step 3: Review permissions

Clocky requires these permissions to function properly:

• Send Messages: Post check-in/check-out confirmations
• Use Slash Commands: Provide /checkin, /checkout, and other commands
• Read Message History: (Optional) For context in support channels

Step 4: Authorize

1. Review the permissions list
2. Click Authorize
3. Complete any CAPTCHA if prompted
4. Wait for confirmation message

Verify installation

Check bot presence

1. Look for Clocky in your server's member list
2. The bot should appear online (green status)
3. You should see it in the right sidebar under "Bots" or "Members"

Test basic functionality

Run a simple command to verify Clocky is responding:

/checkin

Expected response:

✅ Checked in at [current time]
Your work session has started!

If you see this, Clocky is successfully installed!

Troubleshooting installation

Initial configuration

After installation, configure these essential settings:

1. Set auto-close duration

Configure how long sessions stay open before automatic closure:

/admin-set-autoclose hours:12

Recommended values:

• 8 hours: Standard workday
• 12 hours: Default (includes overtime)
• 24 hours: Flexible/shift work

2. Configure deletion policy

Set up data deletion behavior:

/admin-configure-deletion set-policy policy:immediate

Policy options:

• immediate: Data deleted instantly when requested
• grace_period: Delay deletion for recovery (configurable days)
• requires_approval: Admin must approve deletion requests

See Deletion Policies for detailed configuration.

3. Test user workflow

Have a test user (or yourself) run through the basic workflow:

# 1. Check in
/checkin

# 2. Check status
/status

# 3. Start a break
/break start

# 4. End break
/break end

# 5. Check out
/checkout

# 6. View stats
/stats range:today

4. Set up notification channel (optional)

While Clocky doesn't require a dedicated channel, consider:

• Creating a #clocky-logs channel for tracking
• Setting up a #time-tracking channel for users
• Enabling bot permissions in specific channels only

Permissions setup

Required permissions

Clocky needs these permissions to function:

Permission levels by role

Configure which users can access certain features:

Channel-specific permissions

You can restrict Clocky to specific channels:

1. Go to Server Settings → Roles
2. Find "Clocky" role
3. Edit permissions
4. Disable "View Channels" at server level
5. Enable "View Channels" for specific channels only

Post-setup checklist

Before rolling out to your team:

Next steps

Now that Clocky is set up:

Common setup issues

Bot invited but not appearing

Cause: Discord sync delay or permissions issue

Solution:

1. Wait 2-3 minutes for Discord to sync
2. Restart your Discord client
3. Check if bot appears in offline members
4. Re-invite if still not visible

Commands not showing up

Cause: Discord hasn't registered slash commands yet

Solution:

1. Wait up to 1 hour for Discord to sync
2. Try / in a channel - commands should appear
3. Restart Discord app
4. If still missing, check bot has "Use Application Commands" permission

Permission denied errors

Cause: Missing required permissions

Solution:

1. Check bot role permissions in Server Settings
2. Ensure "Send Messages" and "Use Application Commands" are enabled
3. Re-invite bot with correct permissions
4. Move bot role above member roles in hierarchy

Users can't run commands

Cause: Channel permissions or bot visibility

Solution:

1. Ensure bot can see the channel
2. Grant @everyone permission to use slash commands
3. Check channel-specific overrides aren't blocking bot
4. Verify bot role is above member roles

Support

Need help with setup? Check out:

• Troubleshooting Guide
• Installation Issues
• FAQ
• Join our Support Server