Open platform to collect and prioritize feedback
package cmd
import (
"net/http"
"time"
"github.com/getfider/fider/app/handlers"
"github.com/getfider/fider/app/handlers/apiv1"
"github.com/getfider/fider/app/handlers/webhooks"
"github.com/getfider/fider/app/middlewares"
"github.com/getfider/fider/app/models/enum"
"github.com/getfider/fider/app/pkg/env"
"github.com/getfider/fider/app/pkg/web"
)
func routes(r *web.Engine) *web.Engine {
r.Worker().Use(middlewares.WorkerSetup())
r.Get("/_health", handlers.Health())
r.Use(middlewares.CatchPanic())
r.Use(middlewares.Instrumentation())
r.NotFound(func(c *web.Context) error {
mw := middlewares.Chain(
middlewares.WebSetup(),
middlewares.Tenant(),
middlewares.NoIndex(),
middlewares.User(),
)
next := mw(func(c *web.Context) error {
return c.NotFound()
})
return next(c)
})
r.Use(middlewares.Secure())
r.Use(middlewares.Compress())
assets := r.Group()
{
assets.Use(middlewares.CORS())
assets.Use(middlewares.ClientCache(365 * 24 * time.Hour))
assets.Get("/static/favicon", handlers.Favicon())
assets.Static("/assets/*filepath", "dist")
assets.Static("/static/assets/*filepath", "static")
}
feed := r.Group()
{
feed.Use(middlewares.CORS())
feed.Use(middlewares.WebSetup())
feed.Use(middlewares.Tenant())
feed.Use(middlewares.NoIndex())
feed.Use(middlewares.ClientCache(5 * time.Minute))
feed.Get("/feed/global.atom", handlers.GlobalFeed())
feed.Get("/feed/posts/:path", handlers.CommentFeed())
}
r.Use(middlewares.Session())
r.Get("/robots.txt", handlers.RobotsTXT())
r.Post("/_api/log-error", handlers.LogError())
r.Use(middlewares.Maintenance())
r.Use(middlewares.WebSetup())
r.Use(middlewares.Tenant())
r.Use(middlewares.NoIndex())
r.Use(middlewares.User())
r.Get("/privacy", handlers.LegalPage("Privacy Policy", "privacy.md"))
// Stripe webhooks (before CSRF middleware)
stripeWh := r.Group()
{
stripeWh.Post("/webhooks/stripe", webhooks.IncomingStripeWebhook())
}
r.Use(middlewares.CSRF())
r.Get("/terms", handlers.LegalPage("Terms of Service", "terms.md"))
r.Post("/_api/tenants", handlers.CreateTenant())
r.Get("/_api/tenants/:subdomain/availability", handlers.CheckAvailability())
r.Get("/signup", handlers.SignUp())
r.Get("/oauth/:provider", handlers.SignInByOAuth())
r.Get("/oauth/:provider/callback", handlers.OAuthCallback())
// Starting from this step, a Tenant is required
r.Use(middlewares.RequireTenant())
r.Get("/sitemap.xml", handlers.Sitemap())
tenantAssets := r.Group()
{
tenantAssets.Use(middlewares.ClientCache(5 * 24 * time.Hour))
tenantAssets.Get("/static/avatars/letter/:id/:name", handlers.LetterAvatar())
tenantAssets.Get("/static/avatars/gravatar/:id/*name", handlers.Gravatar())
tenantAssets.Use(middlewares.ClientCache(30 * 24 * time.Hour))
tenantAssets.Get("/static/favicon/*bkey", handlers.Favicon())
tenantAssets.Get("/static/images/*bkey", handlers.ViewUploadedImage())
tenantAssets.Get("/static/custom/:md5.css", func(c *web.Context) error {
return c.Blob(http.StatusOK, "text/css", []byte(c.Tenant().CustomCSS))
})
}
r.Get("/_design", handlers.Page("Design System", "A preview of Fider UI elements", "DesignSystem/DesignSystem.page"))
r.Get("/signup/verify", handlers.VerifySignUpKey())
r.Post("/_api/signup/resend", handlers.ResendSignUpEmail())
r.Get("/signout", handlers.SignOut())
r.Get("/oauth/:provider/token", handlers.OAuthToken())
r.Get("/oauth/:provider/echo", handlers.OAuthEcho())
// If tenant is pending, block it from using any other route
r.Use(middlewares.BlockPendingTenants())
r.Get("/signin", handlers.SignInPage())
r.Get("/signin/complete", handlers.CompleteSignInProfilePage())
r.Get("/not-invited", handlers.NotInvitedPage())
r.Get("/access-denied", handlers.AccessDeniedPage())
r.Get("/signin/verify", handlers.VerifySignInKey(enum.EmailVerificationKindSignIn))
r.Get("/invite/verify", handlers.VerifySignInKey(enum.EmailVerificationKindUserInvitation))
r.Post("/_api/signin/complete", handlers.CompleteSignInProfile())
r.Post("/_api/signin", handlers.SignInByEmail())
r.Post("/_api/signin/newuser", handlers.SignInByEmailWithName())
r.Post("/_api/signin/verify", handlers.VerifySignInCode())
r.Post("/_api/signin/resend", handlers.ResendSignInCode())
// Cancel a scheduled site deletion. Authorised by the unguessable key in the emailed link
// alone, so it must stay reachable without authentication (it only restores access).
if !env.IsSingleHostMode() {
r.Get("/admin/danger-zone/cancel", handlers.CancelTenantDeletion())
}
// Block if it's private tenant with unauthenticated user
r.Use(middlewares.CheckTenantPrivacy())
r.Get("/", handlers.Index())
r.Get("/roadmap", handlers.RoadmapPage())
r.Get("/posts/:number", handlers.PostDetails())
r.Get("/posts/:number/:slug", handlers.PostDetails())
ui := r.Group()
{
// From this step, a User is required
ui.Use(middlewares.IsAuthenticated())
ui.Get("/settings", handlers.UserSettings())
ui.Get("/notifications", handlers.Notifications())
ui.Get("/notifications/:id", handlers.ReadNotification())
ui.Get("/_api/notifications/unread", handlers.GetAllNotifications())
ui.Get("/change-email/verify", handlers.VerifyChangeEmailKey())
ui.Delete("/_api/user", handlers.DeleteUser())
ui.Post("/_api/user/regenerate-apikey", handlers.RegenerateAPIKey())
ui.Post("/_api/user/settings", handlers.UpdateUserSettings())
ui.Post("/_api/user/change-email", handlers.ChangeUserEmail())
ui.Post("/_api/notifications/read-all", handlers.ReadAllNotifications())
ui.Get("/_api/notifications/unread/total", handlers.TotalUnreadNotifications())
// From this step, only Collaborators and Administrators are allowed
ui.Use(middlewares.IsAuthorized(enum.RoleCollaborator, enum.RoleAdministrator))
// locale is forced to English for administrative pages.
// This is meant to be removed when all pages are translated.
ui.Use(middlewares.SetLocale("en"))
ui.Get("/admin", handlers.GeneralSettingsPage())
ui.Get("/admin/advanced", handlers.AdvancedSettingsPage())
ui.Get("/admin/privacy", handlers.Page("Privacy · Site Settings", "", "Administration/pages/PrivacySettings.page"))
ui.Get("/admin/invitations", handlers.Page("Invitations · Site Settings", "", "Administration/pages/Invitations.page"))
ui.Get("/admin/users", handlers.ManageMembers())
ui.Get("/admin/tags", handlers.ManageTags())
ui.Get("/admin/authentication", handlers.ManageAuthentication())
ui.Get("/_api/admin/oauth/:provider", handlers.GetOAuthConfig())
// Pro features (available to self-hosters and pro hosted customers)
proUi := ui.Group()
{
proUi.Use(middlewares.RequirePro())
proUi.Get("/admin/moderation", handlers.ModerationPage())
}
// From this step, only Administrators are allowed
ui.Use(middlewares.IsAuthorized(enum.RoleAdministrator))
// Danger Zone — delete the entire site. Hosted multi-tenant only; owner-only is
// enforced inside the handlers.
if !env.IsSingleHostMode() {
ui.Get("/admin/danger-zone", handlers.DangerZonePage())
ui.Delete("/_api/admin/tenant", handlers.RequestTenantDeletion())
ui.Post("/_api/admin/tenant/cancel-deletion", handlers.CancelTenantDeletionByOwner())
}
ui.Get("/admin/export", handlers.Page("Export · Site Settings", "", "Administration/pages/Export.page"))
ui.Get("/admin/export/posts.csv", handlers.ExportPostsToCSV())
ui.Get("/admin/export/backup.zip", handlers.ExportBackupZip())
ui.Get("/admin/export/tags.json", handlers.ExportTagsJSON())
ui.Post("/_api/admin/import/tags", handlers.ImportTagsJSON())
ui.Get("/admin/webhooks", handlers.ManageWebhooks())
ui.Post("/_api/admin/webhook", handlers.CreateWebhook())
ui.Put("/_api/admin/webhook/:id", handlers.UpdateWebhook())
ui.Delete("/_api/admin/webhook/:id", handlers.DeleteWebhook())
ui.Post("/_api/admin/webhook/test/:id", handlers.TestWebhook())
ui.Post("/_api/admin/webhook/preview", handlers.PreviewWebhook())
ui.Get("/_api/admin/webhook/props/:type", handlers.GetWebhookProps())
ui.Post("/_api/admin/settings/general", handlers.UpdateSettings())
ui.Post("/_api/admin/settings/advanced", handlers.UpdateAdvancedSettings())
ui.Post("/_api/admin/settings/privacy", handlers.UpdatePrivacySettings())
ui.Post("/_api/admin/settings/emailauth", handlers.UpdateEmailAuthAllowed())
ui.Post("/_api/admin/oauth", handlers.SaveOAuthConfig())
ui.Post("/_api/admin/oauth/:provider/status", handlers.SetSystemProviderStatus())
ui.Post("/_api/admin/roles/:role/users", handlers.ChangeUserRole())
ui.Put("/_api/admin/users/:userID/block", handlers.BlockUser())
ui.Delete("/_api/admin/users/:userID/block", handlers.UnblockUser())
ui.Put("/_api/admin/users/:userID/trust", handlers.TrustUser())
ui.Delete("/_api/admin/users/:userID/trust", handlers.UntrustUser())
// Pro features (available to self-hosters and pro hosted customers)
proAdmin := ui.Group()
{
proAdmin.Use(middlewares.RequirePro())
proAdmin.Get("/_api/admin/moderation/items", handlers.GetModerationItems())
proAdmin.Get("/_api/admin/moderation/count", handlers.GetModerationCount())
}
if env.IsBillingEnabled() {
ui.Get("/admin/billing", handlers.ManageBilling())
ui.Post("/_api/admin/billing/portal", handlers.CreateStripePortalSession())
ui.Post("/_api/admin/billing/checkout", handlers.CreateStripeCheckoutSession())
ui.Post("/_api/admin/billing/checkout/annual", handlers.CreateStripeAnnualCheckoutSession())
}
}
// Public operations
// Does not require authentication
publicApi := r.Group()
{
publicApi.Get("/api/v1/similarposts", apiv1.FindSimilarPosts())
publicApi.Get("/api/v1/posts", apiv1.SearchPosts())
publicApi.Get("/api/v1/tags", apiv1.ListTags())
publicApi.Get("/api/v1/posts/:number", apiv1.GetPost())
publicApi.Get("/api/v1/posts/:number/comments", apiv1.ListComments())
publicApi.Get("/api/v1/posts/:number/comments/:id", apiv1.GetComment())
publicApi.Get("/api/v1/taggable-users", apiv1.ListTaggableUsers())
publicApi.Get("/api/v1/posts/:number/votes", apiv1.ListVotes())
}
// Operations used to manage the content of a site
// Available to any authenticated user
membersApi := r.Group()
{
membersApi.Use(middlewares.IsAuthenticated())
membersApi.Use(middlewares.BlockLockedTenants())
membersApi.Post("/api/v1/posts", apiv1.CreatePost())
membersApi.Put("/api/v1/posts/:number", apiv1.UpdatePost())
membersApi.Post("/api/v1/posts/:number/comments/:id/reactions/:reaction", apiv1.ToggleReaction())
membersApi.Post("/api/v1/posts/:number/comments", apiv1.PostComment())
membersApi.Put("/api/v1/posts/:number/comments/:id", apiv1.UpdateComment())
membersApi.Delete("/api/v1/posts/:number/comments/:id", apiv1.DeleteComment())
membersApi.Post("/api/v1/posts/:number/votes", apiv1.AddVote())
membersApi.Delete("/api/v1/posts/:number/votes", apiv1.RemoveVote())
membersApi.Post("/api/v1/posts/:number/votes/toggle", apiv1.ToggleVote())
membersApi.Post("/api/v1/posts/:number/subscription", apiv1.Subscribe())
membersApi.Delete("/api/v1/posts/:number/subscription", apiv1.Unsubscribe())
membersApi.Use(middlewares.IsAuthorized(enum.RoleCollaborator, enum.RoleAdministrator))
membersApi.Put("/api/v1/posts/:number/status", apiv1.SetResponse())
}
// Operations used to manage a site
// Available to both collaborators and administrators
staffApi := r.Group()
{
staffApi.Use(middlewares.SetLocale("en"))
staffApi.Use(middlewares.IsAuthenticated())
staffApi.Use(middlewares.IsAuthorized(enum.RoleCollaborator, enum.RoleAdministrator))
staffApi.Get("/api/v1/users", apiv1.ListUsers())
staffApi.Post("/api/v1/invitations/send", apiv1.SendInvites())
staffApi.Post("/api/v1/invitations/sample", apiv1.SendSampleInvite())
staffApi.Use(middlewares.BlockLockedTenants())
staffApi.Post("/api/v1/posts/:number/tags/:slug", apiv1.AssignTag())
staffApi.Delete("/api/v1/posts/:number/tags/:slug", apiv1.UnassignTag())
}
// Operations used to manage a site
// Only available to administrators
adminApi := r.Group()
{
adminApi.Use(middlewares.SetLocale("en"))
adminApi.Use(middlewares.IsAuthenticated())
adminApi.Use(middlewares.IsAuthorized(enum.RoleAdministrator))
adminApi.Post("/api/v1/users", apiv1.CreateUser())
adminApi.Post("/api/v1/tags", apiv1.CreateEditTag())
adminApi.Put("/api/v1/tags/:slug", apiv1.CreateEditTag())
adminApi.Delete("/api/v1/tags/:slug", apiv1.DeleteTag())
// Pro features (available to self-hosters and pro hosted customers)
proAdminApi := adminApi.Group()
{
proAdminApi.Use(middlewares.RequirePro())
proAdminApi.Post("/api/v1/admin/moderation/posts/:id/approve-and-verify", apiv1.ApprovePostAndVerify())
proAdminApi.Post("/api/v1/admin/moderation/posts/:id/decline-and-block", apiv1.DeclinePostAndBlock())
proAdminApi.Post("/api/v1/admin/moderation/posts/:id/approve", apiv1.ApprovePost())
proAdminApi.Post("/api/v1/admin/moderation/posts/:id/decline", apiv1.DeclinePost())
proAdminApi.Post("/api/v1/admin/moderation/comments/:id/approve-and-verify", apiv1.ApproveCommentAndVerify())
proAdminApi.Post("/api/v1/admin/moderation/comments/:id/decline-and-block", apiv1.DeclineCommentAndBlock())
proAdminApi.Post("/api/v1/admin/moderation/comments/:id/approve", apiv1.ApproveComment())
proAdminApi.Post("/api/v1/admin/moderation/comments/:id/decline", apiv1.DeclineComment())
}
adminApi.Use(middlewares.BlockLockedTenants())
adminApi.Delete("/api/v1/posts/:number", apiv1.DeletePost())
}
return r
}