forem

(★ 22,769)

For empowering community 🌱

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

- pipeline.containers.yml
- devcontainer.json
- postAttachCommand-init.sh
- postCreateCommand-init.sh
- .psqlrc
- settings.json
- .gitignore
- - -core-team-only---new-approved-feature.md
  - bug_report.md
  - config.yml
  - feature_request.md
- - build-base-ruby-image.yml
  - buildkite.yml
  - cd.yml
  - ci.yml
  - cla.yml
  - cleanup-cache.yml
  - codeql-analysis.yml
  - create-cache.yml
  - issue.yml
  - pr.yml
  - stale.yml
- CODEOWNERS
- copilot-instructions.md
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- pre-commit
- - docker-setup.sample
  - post-app-boot.sample
  - post-deploy.sample
  - post-proxy-reboot.sample
  - pre-app-boot.sample
  - pre-build.sample
  - pre-connect.sample
  - pre-deploy.sample
  - pre-proxy-reboot.sample
- secrets
- automations.yaml
- verify-setup.sh
- extensions.json
- launch.json
- settings.json
- - yarn-4.1.0.cjs
- - agent_sessions_controller.rb
  - ai_chats_controller.rb
  - ai_image_generations_controller.rb
  - api_secrets_controller.rb
  - application_controller.rb
  - application_metal_controller.rb
  - article_approvals_controller.rb
  - articles_controller.rb
  - async_info_controller.rb
  - auth_pass_controller.rb
  - badges_controller.rb
  - billboard_events_controller.rb
  - billboards_controller.rb
  - bottom_items_controller.rb
  - calendar_controller.rb
  - collections_controller.rb
  - comments_controller.rb
  - community_controller.rb
  - confirmations_controller.rb
  - credits_controller.rb
  - dashboards_controller.rb
  - deep_links_controller.rb
  - dev_tools_controller.rb
  - devices_controller.rb
  - discussion_locks_controller.rb
  - email_authorizations_controller.rb
  - email_subscriptions_controller.rb
  - event_signups_controller.rb
  - events_controller.rb
  - favorites_controller.rb
  - feed_events_controller.rb
  - feedback_messages_controller.rb
  - followings_controller.rb
  - follows_controller.rb
  - ga_events_controller.rb
  - github_repos_controller.rb
  - image_uploads_controller.rb
  - insights_controller.rb
  - invitations_controller.rb
  - lead_submissions_controller.rb
  - leaderboards_controller.rb
  - leadership_dashboards_controller.rb
  - liquid_embeds_controller.rb
  - liquid_tags_controller.rb
  - magic_links_controller.rb
  - menus_controller.rb
  - moderations_controller.rb
  - notification_subscriptions_controller.rb
  - notifications_controller.rb
  - omniauth_callbacks_controller.rb
  - onboardings_controller.rb
  - open_search_controller.rb
  - organization_lead_forms_controller.rb
  - organization_pages_controller.rb
  - organization_settings_controller.rb
  - organizations_controller.rb
  - page_views_controller.rb
  - pages_controller.rb
  - passwords_controller.rb
  - podcast_episodes_controller.rb
  - podcasts_controller.rb
  - poll_skips_controller.rb
  - poll_text_responses_controller.rb
  - poll_votes_controller.rb
  - pro_accounts_controller.rb
  - profile_field_groups_controller.rb
  - profile_pins_controller.rb
  - profile_preview_cards_controller.rb
  - profiles_controller.rb
  - rating_votes_controller.rb
  - reactions_controller.rb
  - reading_list_items_controller.rb
  - registrations_controller.rb
  - response_templates_controller.rb
  - search_controller.rb
  - service_worker_controller.rb
  - sessions_controller.rb
  - sidebars_controller.rb
  - sitemaps_controller.rb
  - stories_controller.rb
  - stripe_active_cards_controller.rb
  - stripe_subscriptions_controller.rb
  - subforems_controller.rb
  - surveys_controller.rb
  - tag_adjustments_controller.rb
  - tags_controller.rb
  - trends_controller.rb
  - user_blocks_controller.rb
  - user_subscriptions_controller.rb
  - users_controller.rb
  - video_states_controller.rb
  - videos_controller.rb
- - application_decorator.rb
  - article_decorator.rb
  - campaign_decorator.rb
  - comment_decorator.rb
  - mention_decorator.rb
  - notification_decorator.rb
  - organization_decorator.rb
  - podcast_episode_decorator.rb
  - profile_decorator.rb
  - user_decorator.rb
- - fastly_config.rb
  - liquid_tags.rb
  - moderation_unauthorized_error.rb
  - payments.rb
  - search.rb
  - subclass_responsibility.rb
  - uninferrable_decorator_error.rb
- - creator_settings_form.rb
- - admin_api_users_helper.rb
  - admin_helper.rb
  - agent_sessions_helper.rb
  - application_helper.rb
  - articles_helper.rb
  - authentication_helper.rb
  - billboard_helper.rb
  - broadcasts_helper.rb
  - color_helper.rb
  - comments_helper.rb
  - crayons_helper.rb
  - date_helper.rb
  - events_helper.rb
  - favorites_helper.rb
  - feedback_messages_helper.rb
  - i18n_helper.rb
  - notifications_helper.rb
  - organization_helper.rb
  - profile_helper.rb
  - rate_limit_checker_helper.rb
  - scheduled_automations_helper.rb
  - settings_helper.rb
  - social_image_helper.rb
  - social_link_helper.rb
  - users_helper.rb
- - .eslintrc.js
  - netlify.toml
  - routes.js.erb
- - api_constraints.rb
  - app_secrets.rb
  - black_box.rb
  - html_css_to_image.rb
  - menu.rb
  - org_custom_domain_constraint.rb
  - rails_env_constraint.rb
  - release_phase_notifier.rb
  - seeder.rb
  - string_attribute_cleaner.rb
  - throttled_call.rb
  - url.rb
  - url_domain_helper.rb
- - agent_session_tag.rb
  - asciinema_tag.rb
  - bandcamp_tag.rb
  - blogcast_tag.rb
  - bluesky_tag.rb
  - bolt_tag.rb
  - card_tag.rb
  - cloud_run_tag.rb
  - codepen_tag.rb
  - codesandbox_tag.rb
  - col_tag.rb
  - comment_tag.rb
  - cta_tag.rb
  - descript_tag.rb
  - details_tag.rb
  - dotnet_fiddle_tag.rb
  - event_tag.rb
  - feature_tag.rb
  - features_tag.rb
  - feed_tag.rb
  - forem_tag.rb
  - gist_tag.rb
  - git_pitch_tag.rb
  - github_tag.rb
  - glitch_tag.rb
  - huggingface_tag.rb
  - instagram_tag.rb
  - js_fiddle_tag.rb
  - jsitor_tag.rb
  - katex_tag.rb
  - kotlin_tag.rb
  - legacy_code_tag.rb
  - link_tag.rb
  - liquid_tag_base.rb
  - livecodes_tag.rb
  - loom_tag.rb
  - lovable_tag.rb
  - medium_tag.rb
  - mux_tag.rb
  - neon_tag.rb
  - netlify_tag.rb
  - next_tech_tag.rb
  - null_tag.rb
  - offer_tag.rb
  - open_graph_tag.rb
  - org_lead_form_tag.rb
  - org_posts_tag.rb
  - org_team_tag.rb
  - organization_tag.rb
  - parler_tag.rb
  - podcast_tag.rb
  - poll_tag.rb
  - quote_tag.rb
  - quotes_tag.rb
  - reddit_tag.rb
  - replit_tag.rb
  - row_tag.rb
  - slide_tag.rb
  - slides_tag.rb
  - slideshare_tag.rb
  - soundcloud_tag.rb
  - speakerdeck_tag.rb
  - spotify_tag.rb
  - stackblitz_tag.rb
  - stackery_tag.rb
  - stackexchange_tag.rb
  - survey_tag.rb
  - tag_tag.rb
  - tweet_tag.rb
  - twitch_tag.rb
  - twitter_timeline_tag.rb
  - unified_embed.rb
  - user_subscription_tag.rb
  - user_tag.rb
  - vimeo_tag.rb
  - warp_tag.rb
  - wikipedia_tag.rb
  - youtube_tag.rb
- - application_mailer.rb
  - custom_mailer.rb
  - devise_mailer.rb
  - digest_mailer.rb
  - notify_mailer.rb
  - organization_invitation_mailer.rb
  - organization_membership_notification_mailer.rb
  - survey_mailer.rb
  - verification_mailer.rb
- - ab_experiment.rb
  - admin_menu.rb
  - agent_session.rb
  - ai_audit.rb
  - announcement.rb
  - api_secret.rb
  - application_record.rb
  - article.rb
  - article_activity.rb
  - async_info.rb
  - audience_segment.rb
  - audit_log.rb
  - badge.rb
  - badge_achievement.rb
  - banished_user.rb
  - billboard.rb
  - billboard_event.rb
  - billboard_placement_area_config.rb
  - blocked_email_domain.rb
  - broadcast.rb
  - campaign.rb
  - collection.rb
  - comment.rb
  - concept.rb
  - concept_access.rb
  - concept_daily_metric.rb
  - concept_membership.rb
  - config.rb
  - consumer_app.rb
  - context_note.rb
  - context_notification.rb
  - creator_setting.rb
  - credit.rb
  - cross_model_slug.rb
  - data_update_script.rb
  - device.rb
  - discussion_lock.rb
  - email.rb
  - email_authorization.rb
  - email_message.rb
  - event.rb
  - event_signup.rb
  - extension.rb
  - feed_config.rb
  - feed_event.rb
  - feedback_message.rb
  - follow.rb
  - forem_instance.rb
  - gdpr_delete_request.rb
  - geolocation.rb
  - github_issue.rb
  - github_repo.rb
  - html_variant.rb
  - identity.rb
  - invitation.rb
  - label.rb
  - lead_submission.rb
  - linked_domain.rb
  - liquid_embed_reference.rb
  - listing.rb
  - media_store.rb
  - mention.rb
  - mod.rb
  - moderator_action.rb
  - navigation_link.rb
  - note.rb
  - notification.rb
  - notification_subscription.rb
  - onboarding_checklist.rb
  - organization.rb
  - organization_lead_form.rb
  - organization_membership.rb
  - overview.rb
  - page.rb
  - page_template.rb
  - page_view.rb
  - permission.rb
  - pinned_article.rb
  - podcast.rb
  - podcast_episode.rb
  - podcast_episode_appearance.rb
  - podcast_ownership.rb
  - poll.rb
  - poll_option.rb
  - poll_skip.rb
  - poll_text_response.rb
  - poll_vote.rb
  - privileged_reaction.rb
  - profile.rb
  - profile_field.rb
  - profile_field_group.rb
  - profile_pin.rb
  - rating_vote.rb
  - reaction.rb
  - reaction_category.rb
  - recommended_articles_list.rb
  - request_redirect.rb
  - response_template.rb
  - role.rb
  - scheduled_automation.rb
  - secret.rb
  - segmented_user.rb
  - space.rb
  - subforem.rb
  - survey.rb
  - survey_completion.rb
  - tag.rb
  - tag_adjustment.rb
  - tag_subforem_relationship.rb
  - timeframe.rb
  - tool.rb
  - trend.rb
  - trend_membership.rb
  - tweet.rb
  - user.rb
  - user_activity.rb
  - user_block.rb
  - user_language.rb
  - user_query.rb
  - user_role.rb
  - user_subscription.rb
  - user_visit_context.rb
  - webpage_reference.rb
  - welcome.rb
  - welcome_notification.rb
- - admin_policy.rb
  - agent_session_policy.rb
  - ai_image_generation_policy.rb
  - api_secret_policy.rb
  - application_policy.rb
  - article_policy.rb
  - authorizer.rb
  - badge_achievement_policy.rb
  - badge_policy.rb
  - comment_policy.rb
  - community_bot_policy.rb
  - consumer_app_policy.rb
  - discussion_lock_policy.rb
  - event_policy.rb
  - event_signup_policy.rb
  - favorite_policy.rb
  - follow_policy.rb
  - github_repo_policy.rb
  - html_variant_policy.rb
  - image_upload_policy.rb
  - internal_policy.rb
  - liquid_tag_policy.rb
  - listing_policy.rb
  - message_policy.rb
  - organization_policy.rb
  - pinned_article_policy.rb
  - rating_vote_policy.rb
  - reaction_policy.rb
  - registration_policy.rb
  - response_template_policy.rb
  - role_policy.rb
  - space_policy.rb
  - stripe_active_card_policy.rb
  - stripe_subscription_policy.rb
  - subforem_policy.rb
  - tag_policy.rb
  - user_block_policy.rb
  - user_policy.rb
  - video_policy.rb
- - hash_any_key.rb
  - string_to_boolean.rb
- - comment_email_scrubber.rb
  - feed_markdown_scrubber.rb
  - rendered_markdown_scrubber.rb
- - application_serializer.rb
- - algolia_insights_service.rb
  - analytics_service.rb
  - application_service.rb
  - article_api_index_service.rb
  - article_with_video_creation_service.rb
  - billboard_event_rollup.rb
  - bulk_sql_delete.rb
  - calculate_reaction_points.rb
  - comment_creator.rb
  - community_leaders.rb
  - content_renderer.rb
  - email_digest.rb
  - email_digest_article_collector.rb
  - feature_flag.rb
  - flare_tag.rb
  - googlebot_verifier.rb
  - instrumentation.rb
  - liquid_embed_extractor.rb
  - markdown_processor.rb
  - medium_article_retrieval_service.rb
  - notifications.rb
  - open_graph.rb
  - page_view_rollup.rb
  - rate_limit_checker.rb
  - reaction_handler.rb
  - read_only_database_service.rb
  - subforem_reassignment_service.rb
  - survey_completion_service.rb
  - tag_adjustment_creation_service.rb
  - tag_adjustment_update_service.rb
  - user_activity_heatmap_service.rb
  - user_query_executor.rb
  - user_query_validator.rb
  - user_query_variable_substitutor.rb
  - webpage_extractor.rb
- - article_image_uploader.rb
  - badge_uploader.rb
  - base_uploader.rb
  - cover_image_uploader.rb
  - event_cover_image_uploader.rb
  - logo_svg_uploader.rb
  - logo_uploader.rb
  - navigation_link_image_uploader.rb
  - profile_image_uploader.rb
  - subforem_image_uploader.rb
- - bytesize_validator.rb
  - color_contrast_validator.rb
  - cross_model_slug_validator.rb
  - email_safe_html_validator.rb
  - emoji_only_validator.rb
  - enabled_countries_hash_validator.rb
  - existing_published_article_id_validator.rb
  - profile_validator.rb
  - valid_domain_csv_validator.rb
- - cloud_cover_url.rb
  - data_info.rb
  - mux_parser.rb
  - twitch_parser.rb
  - youtube_parser.rb
.cursorrules
.dockerignore
.editorconfig
.env_sample
.erb-lint.yml
.eslintignore
.eslintrc.js
.gitattributes
.gitignore
.gitpod.yml
.lintstagedrc.js
.mise.toml
.nvmrc
.prettierignore
.prettierrc.json
.rspec
.rubocop.yml
.rubocop_todo.yml
.ruby-version
.ruby-version-next
.simplecov
.slugignore
.solargraph.yml
.windsurfrules
.yardopts
.yarnrc.yml
AGENTS.md
Brewfile
Brewfile.lock.json
CHANGELOG.md
CLA.md
CLAUDE.md
CODE_OF_CONDUCT.md
Containerfile
Containerfile.base
Dockerfile
Gemfile
Gemfile.lock
Guardfile
LICENSE.md
Procfile
Procfile.dev
Procfile.dev-hot
Rakefile
README.md
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/forem/forem

Downloads the entire project code from GitHub to your computer.

cd forem

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t forem .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 forem

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd app/javascript/shared/preact

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Ruby

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Ruby Ruby is required to use the bundle command.

bundle exec kamal config

Type this command into your terminal and run it.

bundle exec kamal setup

Type this command into your terminal and run it.

bundle exec kamal deploy

Type this command into your terminal and run it.

✅ If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

forem

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Ruby

Today's picks

Was this content helpful?

Recent Feedback

forem

File Explorer

# Installation Guide

2. Docker

3. Node.js

4. Ruby

Today's picks

Was this content helpful?

Recent Feedback

Download README