aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 03c661f139760f21f8cc4dafd25f1da62618a27d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
       .'.'
      .'-'.
  .  (  o O)
   \_ `  _,   _
-.___'.) ( ,-'
     '-.O.'-..-..       octopus git web frontend
 ./\/\/ | \_.-._
        ;
     ._/


A git web frontend that wants to hug your code.


Configuration
-------------

octopus is easy to configure and run, even on systems that don't give
you priviledged system access.  The main server binary is configured
primarily with a few environment variables, and an app config.

+ OCTOPUS_CONFIG should contain the path of the main configuration

+ OCTOPUS_SSL_KEY can optionally be set to the path of a certificate key

+ OCTOPUS_SSL_CERT can optionally be set to the path of a certificate


The main configuration file is written in yaml, and outlines things
like the application domain, repo paths, and added modules.  Because
octopus is vory modular, you can only depend on certain features.


---
app_path: git.octopus.example
port: 8080
handle_ssl: false
cache_path: /var/cache/octopus
repo_path: /var/lib/octopus/repos
repo_discovery: false  # Disables automatic config loading from repo_path
                       # and instead let's you set a static set of repos
                       # in the section below
repos:
  - octopus:
      description: "🐙 It's a water animal"
      category: "/"
  - libkookie:
      description: "My personal nix expressions"
      category: "/nix"