project-intro.html 7.79 KB
Newer Older
Erik Huelsmann's avatar
Erik Huelsmann committed
1
2
title: Project Hosting
---
Mariano Montone's avatar
Mariano Montone committed
3
4
<a style="clear:both;" class="btn btn-primary float-right" href="/phub"><i class="fa fa-arrow-right"></i>&nbsp;&nbsp;Common-Lisp.net projects</a>

Mariano Montone's avatar
Mariano Montone committed
5
<div style="clear:both;margin-top: 20px;" class="table-of-contents">
6
  <h4 class="bg-primary" style="color:white;">Table of contents</h4>
7
8
9
10
11
12
13
14
15
16
17
18
  <ul>
    <li><a href="#whatyouget">What you get</a></li>
    <li><a href="#creproj">Creating a project</a></li>
    <li><a href="#svn">Subversion access</a></li>
    <li><a href="#website">Website</a></li>
    <li><a href="#mailinglist">Mailinglists</a></li>
    <li><a href="#admin">Administrative requests</a></li>
    <li><a href="#restore">Backups</a></li>
    <li><a href="#trac">Trac</a></li>
  </ul>
</div>

Mariano Montone's avatar
Mariano Montone committed
19
<h1 style="padding-bottom: 30px;"><i class="fa fa-project-diagram"></i>&nbsp;Common-Lisp.net project hosting</h1>
20

21
22
23
24
25
26
<div id="bodyTextWide">
  <h2 id="whatyouget">What you get</h2>

  <p>Hosted projects get web space, mailing lists, and disk space
    for a version control system. We offer git through
    <a href="https://gitlab.common-lisp.net/explore/projects/">GitLab</a>
27
28
29
30
31
32
33
34
35
36
    and Subversion, augmented with Trac.
  </p>

  <p id="project-pages">Projects using GitLab for their version control, can take advantage of
    <a href="https://docs.gitlab.com/ee/user/project/pages/">GitLab Pages</a>
    to host their project site. An example of such a project is the <a
      href="https://gitlab.common-lisp.net/boston-lisp/boston-lisp-site/">Boston Lisp
        site repository</a>; see the <a 
      href="https://gitlab.common-lisp.net/boston-lisp/boston-lisp-site/-/blob/master/.gitlab-ci.yml">.gitlab-ci.yml</a>
    in that project for an example.
37
38
39
40
41
  </p>

  <h2>Requesting access to an existing project</h2>
  <p>If you want to join an existing project, please contact the
    project owners through the project mailing list (usually
42
43
44
45
    &lt;project&gt;-devel@common-lisp.net). Project owners can add
    new members to GitLab projects themselves. For Subversion projects,
    one of the project members will contact the site admins to ask the
    user to be added to their project.</p>
46
47
48
  <p>If the project is orphaned, or has no mailing list, please
    contact admin@common-lisp.net directly.</p>

49
50
51
  <p>Please note that anonymous access is available for
    public Git repositories through https -- repositories can be downloaded
    without requesting access!</p>
52
53


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
  <h2 id="your-access">Your common-lisp.net access</h2>
  <p>To create a new Git project, a GitLab account can be created; please
    notify admin@common-lisp.net about your intent to create projects.
    Due to SPAM, you need to be granted this permission manually.
  </p>
  <p>To join existing Git projects, a GitLab account can be created; with
    that account, access to the existing project can be requested through
    the GitLab interface. Project owners will be notified of your request
    for access.
  </p>
  <p>For Subversion access, a different account is required. An account for
    Subversion access can be requested through admin@common-lisp.net by
    sending an SSH public key. See <a
    href="https://www.cyberciti.biz/faq/how-to-set-up-ssh-keys-on-linux-unix/">the
    instructions by Cyberciti</a> how to set up SSH keys.</a>
  </p>
70

71
72
73
74
75
76
77
78
79
80
81
82
  <p>There are no hard limits on resource-use. Please exercise care; you will be
    sharing this system with others and stick to these basic rules:</p>
    
  <ul>
    <li>No CPU/RAM intensive tasks</li>
    <li>No long-running tasks (no chat clients, <code>screen</code> sessions, etc.)</li>
    <li>Don't use your shell access unless you need to perform administrative tasks on your project(s)</li>
    <li>Only store publicly hosted data on the machine</li>
    <li>To host video or other large assets, please contact admins</li>
    <li>To run cron jobs, please consult with the admins</li>
    <li>Mirrorring of resources on common-lisp.net can be arranged by consulting with admins</li>
  </ul>
83

84
  <h2 id="creproj">Creating a project</h2>
85

86
87
88
89
90
  <p>Users can create Git projects (up to 10) themselves through the GitLab interface
    in their own namespace. GitLab groups (separate namespaces) can be requested through
    an e-mail to admin@common-lisp.net. GitLab groups allow hosting a project site per
    group.
  </p>
91

92
93
94
95
  <p>To request a Subversion project, please contact admin@common-lisp.net. If you don't have
    an account yet, please see the procedure under <a href="#your-access">Your common-lisp.net
    access</a> above.
  </p>
96

97
98
99
100
101
  <p>As a first step, please take some time to set up a simple web-page for your
    project. For GitLab based projects, this can be set up as described in the section
    <a href="#project-pages">What you get</a> above. Subversion-based projects can 
    upload it to our server (via <tt>scp</tt>). See also our section titled
    &quot;<a href="#website">Website</a>&quot;.</p>
102

103
  <p>To send e-mails on push to your project mailing list, follow these steps:</p>
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
  <ol>
    <li>Go to the project's landing page (not the group's), e.g.
      SLIME's: <a href="https://gitlab.common-lisp.net/slime/slime"
               >https://gitlab.common-lisp.net/slime/slime</a></li>
    <li>Click on &quot;Settings&quot; at the bottom of the left
      menu bar</li>
    <li>Click on &quot;Services&quot; in the next page</li>
    <li>From the list of services in the resulting page, select
      &quot;E-mail on push&quot;</li>
    <li>Enter the recipients for push mails, including the
      mailing list name of your project (i.e. &lt;project-name&gt;-cvs@common-lisp.net)</li>
  </ol>

  <h2 id="svn">Subversion repository access</h2>

  <p>Your Subversion repository is in
    <tt>/project/&lt;project-name&gt;/svn</tt>.  By default, any
    commits to it will be sent to
    <tt>&lt;project-name&gt;-cvs@common-lisp.net</tt>.</p>

124
125
126
127
  <p>Anonymous read-only Subversion access is enabled by default.
    Repositories can be accessed through <a
     href="https://svn.common-lisp.net/">https://svn.common-lisp.net/&lt;project&gt;</a>
  </p>
128
129


130
   <h2 id="website">Website</h2>
131

132
133
134
    <p>When the project doesn't use GitLab Pages as described above,
      <tt>/project/&lt;project-name&gt;/public_html</tt> is published
    from our webservers as <tt>http://common-lisp.net/project/&lt;project-name&gt;</tt></p>
135
136

    <p>
137
      Apache <a href="http://httpd.apache.org/docs/howto/ssi.html">Server-Side
138
      Includes</a> are enabled.
139
    </p>
140
141
142



143
    <h2 id="mailinglist">Automatic and manual mailinglists</h2>
144

145
146
147
148
149
    <p>When your project is set up, one mailinglist (&lt;project-name&gt;-devel@common-lisp.net)
      is created. The project requestor is subscribed on initialization.  Any future project members
      will have to subscribe on their own, via the Mailman interface
      at <tt>http://mailman.common-lisp.net/cgi-bin/mailman/listinfo/&lt;project-name&gt;-devel</tt>.
      </p>
150
151
152

    <p>Additional mailing lists available on request.</p>

153

154
    <h2 id="admin">Administrative requests</h2>
155

156
    <p>For adding/removing project members, additional mailing
157
158
159
160
161
      lists, etc, send an email to
      <tt>admin&nbsp;(at)&nbsp;common-lisp&nbsp;(dot)&nbsp;net</tt>
      with all the relevant details (project name, etc).</p>


162
    <h2 id="restore">Restoring from backup</h2>
163

164
165
166
    <p>All the data is backed up regularly both on- and off-site, to cover for scenarios
     of user-accident as well as disaster recovery. There is, however, no provision for
     user-driven recovery. Please be careful before deleting anything in your project.</p>
167

168
    <h2 id="trac">Trac</h2>
169

170
171
172
    <p>We offer a Trac instances for projects to use with their Subversion repository.
      Please specify if want one when you set up your project or email <code>admin (at)
      common-lisp (dot) net</code> to request it for an existing project.</p>
173

174
    <p>To learn more about how Trac works at common-lisp.net, please read
175
176
177
        our <a href="/tools/#trac">Trac @ clnet introduction</a> .


178
</div>