Sider Documentation

Sider Documentation

  • Enterprise
  • News
  • Sider Top

›Enterprise

Getting Started

  • Home
  • Intro Videos
  • Setting up Sider
  • Dashboard Overview
  • Repository Settings
  • Custom Analysis Configuration
  • Recommended Ruleset
  • Working with Issues
  • Permissions
  • Skip Analyzing

Analysis Tools

    Ruby

    • RuboCop
    • Reek
    • Querly
    • Rails Best Practices
    • Brakeman
    • HAML-Lint
    • Slim-Lint (beta)

    Java

    • Checkstyle
    • PMD
    • JavaSee

    Kotlin

    • ktlint (beta)
    • detekt (beta)

    JavaScript and Flavors

    • ESLint
    • JSHint
    • TyScan
    • CoffeeLint
    • TSLint (deprecated)

    CSS

    • stylelint
    • SCSS-Lint (deprecated)

    PHP

    • PHP_CodeSniffer
    • PHPMD
    • Phinder

    Python

    • Flake8
    • Pylint (beta)

    Swift

    • SwiftLint

    Go

    • GolangCI-Lint

    C/C++

    • Cppcheck
    • cpplint
    • Clang-Tidy (beta)

    C#

    • FxCop (beta)

    Shell script

    • ShellCheck

    Dockerfile

    • hadolint

    Markdown

    • remark-lint

    Others

    • Goodcheck
    • Misspell
    • LanguageTool (beta)
    • PMD CPD (beta)

Custom Rules

  • Intro to Custom Rules
  • Goodcheck
  • Tips & Tricks

Advanced Settings

  • Inline Comments
  • Private Dependencies
  • Restricting access to Close button
  • Transferring a repository

Billing and Plans

  • Billing and Plans

Troubleshooting

  • Troubleshooting

Enterprise

  • Outline
  • System Overview
  • Installation
  • Configuration
  • Operation
  • Update
  • Load Balancer
  • MySQL
  • Redis
  • MinIO
  • Amazon S3
  • GitHub Enterprise Server
  • Clustering
  • Example Deployments

    • Single Node with Docker Compose

    Releases

    • Overview
    • January 2021
    • December 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • February 2020
    • January 2020
    • November 2019
    • Older releases

News

  • 2021
  • 2020
  • 2019
Edit

MySQL

This document explains how to set up MySQL for Sider Enterprise.

Requirements

Sider Enterprise requires MySQL 5.7. You cannot use MySQL 5.6 or older. MySQL 8.0 may work, but we do not support the use of this version. Also, the MySQL server should run on a machine that has sufficient storage size and memory space. It depends on the use of customers, but we recommend preparing 8 GiB RAM and 100 GiB storage or higher for the dedicated MySQL server.

Recommended Parameters

You should configure these parameters to handle any requests from Sider Enterprise.

  • max_allowed_packet - The parameter should be set with 134217728 or higher since Sider Enterprise often handles large data.

  • tmp_table_size and max_heap_table_size - We recommend configuring these parameters with 268435456 or higher together. Note they depend on the memory of your MySQL server. You can increase the value more if the memory space is large.

  • innodb_temp_data_file_path - The recommended value is ibtmp1:12M:autoextend:max:5G. Fine-tune the trailing parameter 5G to fit your environment. This size is the maximum size of the temporary tablespace data.

    The queries called by Sider Enterprise consume an in-memory temporary table, and it will be converted to an on-disk temporary table after the size exceeds the smaller of tmp_table_size and max_heap_table_size. The temporary table file size will be extended with innodb_temp_data_file_path, but the default value is ibtmp1:12M:autoextend, which means the file will grow without limitation. Eventually, this would cause out of disk.

Integration with Sider Enterprise

The DATABASE_URL of Sider Enterprise is configured as follows:

mysql2://{USER}:{PASSWORD}@{HOST}:{PORT}/{DATABASE_NAME}?{OPTION1}={VALUE1}&{OPTION2}={VALUE2}
  • USER - The user name to use when connecting to the MySQL server
  • PASSWORD - The password to use when connecting to the MySQL server
  • HOST - The host name of the MySQL server
  • PORT - The port number of the MySQL server
  • DATABASE_NAME - The database name for Sider Enterprise
  • OPTION1=VALUE1, OPTION2=VALUE2, ... - The query parameters to configure the connection

When setting up your MySQL server, you will create USER and its PASSWORD first. Sider Enterprise will try to create the specified DATABASE_NAME unless it does not exist, so the USER should have strong privileges. If you don't want to pass such powerful permissions to the USER, create the DATABASE_NAME on your own, and allow the USER to do ALL operations only for the DATABASE_NAME.

Also, confirm Sider Enterprise services can access to the MySQL server via the specified HOST and PORT.

← Load BalancerRedis →
  • Requirements
  • Recommended Parameters
  • Integration with Sider Enterprise
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.