Module: Gitlab::Pages

Includes:
JwtAuthenticatable
Defined in:
lib/gitlab/pages.rb,
lib/gitlab/pages/settings.rb,
lib/gitlab/pages/url_builder.rb,
lib/gitlab/pages/cache_control.rb,
lib/gitlab/pages/random_domain.rb,
lib/gitlab/pages/deployment_update.rb,
lib/gitlab/pages/virtual_host_finder.rb

Defined Under Namespace

Classes: CacheControl, DeploymentUpdate, RandomDomain, Settings, UrlBuilder, VirtualHostFinder

Constant Summary collapse

VERSION =
File.read(Rails.root.join("GITLAB_PAGES_VERSION")).strip.freeze
INTERNAL_API_REQUEST_HEADER =
'Gitlab-Pages-Api-Request'
MAX_SIZE =
1.terabyte
DEPLOYMENT_EXPIRATION =
24.hours

Constants included from JwtAuthenticatable

JwtAuthenticatable::SECRET_LENGTH

Class Method Summary collapse

Methods included from JwtAuthenticatable

included

Class Method Details

.access_control_is_forced?Boolean

Returns:

  • (Boolean)


23
24
25
26
# File 'lib/gitlab/pages.rb', line 23

def access_control_is_forced?
  ::Gitlab.config.pages.access_control &&
    ::Gitlab::CurrentSettings.current_application_settings.force_pages_access_control
end

.add_unique_domain_to(project) ⇒ Object



32
33
34
35
36
37
38
39
40
41
# File 'lib/gitlab/pages.rb', line 32

def add_unique_domain_to(project)
  return unless enabled?
  # If the project used a unique domain once, it'll always use the same
  return if project.project_setting.pages_unique_domain_in_database.present?

  project.project_setting.pages_unique_domain_enabled = true
  project.project_setting.pages_unique_domain = Gitlab::Pages::RandomDomain.generate(
    project_path: project.path,
    namespace_path: project.parent.full_path)
end

.enabled?Boolean

Returns:

  • (Boolean)


28
29
30
# File 'lib/gitlab/pages.rb', line 28

def enabled?
  Gitlab.config.pages.enabled
end

.multiple_versions_enabled_for?(project) ⇒ Boolean

Returns:

  • (Boolean)


43
44
45
46
47
48
49
# File 'lib/gitlab/pages.rb', line 43

def multiple_versions_enabled_for?(project)
  return false if project.blank?

  ::Feature.enabled?(:pages_multiple_versions_setting, project) &&
    project.licensed_feature_available?(:pages_multiple_versions) &&
    project.project_setting.pages_multiple_versions_enabled
end

.secret_pathObject



19
20
21
# File 'lib/gitlab/pages.rb', line 19

def secret_path
  Gitlab.config.pages.secret_file
end

.verify_api_request(request_headers) ⇒ Object



13
14
15
16
17
# File 'lib/gitlab/pages.rb', line 13

def verify_api_request(request_headers)
  decode_jwt(request_headers[INTERNAL_API_REQUEST_HEADER], issuer: 'gitlab-pages')
rescue JWT::DecodeError
  false
end