recaptime.dev
@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
1@title Diffusion User Guide
2@group userguide
3
4Guide to Diffusion, the Phorge application for hosting and browsing
5repositories.
6
7Overview
8========
9
10Diffusion allows you to create repositories so that you can browse them from
11the web and interact with them from other applications.
12
13Diffusion can host repositories locally, or observe existing remote
14repositories which are hosted elsewhere (for example, on GitHub, Bitbucket, or
15other existing hosting). Both types of repositories can be browsed and
16interacted with, but hosted repositories support some additional triggers
17and access controls which are not available for observed repositories.
18
19Diffusion is integrated with the other tools in the Phorge suite. For
20instance:
21
22 - when you commit Differential revisions to a tracked repository, they are
23 automatically updated and linked to the corresponding commits;
24 - you can add Herald rules to notify you about commits that match certain
25 rules;
26 - for hosted repositories, Herald can enforce granular access control rules;
27 - in all the tools, commit names are automatically linked.
28
29The remainder of this document walks through creating, configuring, and
30managing repositories.
31
32
33Adding Repositories
34===================
35
36Repository administration is accomplished through Diffusion. You can use the
37web interface in Diffusion to observe an external repository or create a new
38hosted repository.
39
40 - For hosted repositories, make sure you go through the setup instructions
41 in @{article:Diffusion User Guide: Repository Hosting} first.
42 - For all repositories, you'll need to be running the daemons. If you have
43 not set them up yet, see @{article:Managing Daemons with phd}.
44
45By default, you must be an administrator to create a new repository. You can
46change this in the application settings.
47
48
49Managing Repositories
50=====================
51
52Diffusion repositories have an array of configurable options and behaviors. For
53details on the available options and guidance on managing and administrating
54repositories, see @{article:Diffusion User Guide: Managing Repositories}.
55
56Repositories can also be managed via the API. For an overview on using the
57API to create and edit repositories, see
58@{article:Diffusion User Guide: Repositories API}.
59
60
61Repository Clustering
62=====================
63
64Phorge repository hosts can be set up in a cluster configuration so you
65can lose hosts with minimal downtime and data loss. This is an advanced feature
66which most installs do not need to pursue.
67
68To get started with clustering, see @{article:Clustering Introduction}. For
69details on repository clustering, see @{article:Cluster: Repositories}.
70
71
72Next Steps
73==========
74
75Continue by:
76
77 - learning how to creating a symbol index at
78 @{article:Diffusion User Guide: Symbol Indexes}; or
79 - setting up repository hosting with
80 @{article:Diffusion User Guide: Repository Hosting}; or
81 - managing repository hooks with
82 @{article:Diffusion User Guide: Commit Hooks}; or
83 - understanding daemons in more detail with
84 @{article:Managing Daemons with phd}.
85
86If you're having trouble getting things working, these topic guides may be
87helpful:
88
89 - get details about automatically taking actions in response to commits in
90 @{article:Diffusion User Guide: Permanent Refs}; or
91 - understand how Phorge updates repositories with
92 @{article:Diffusion User Guide: Repository Updates}; or
93 - fix issues with repository imports with
94 @{article:Troubleshooting Repository Imports}.