Difference between revisions of "JS Admin README"

From XMPP WIKI
Jump to navigation Jump to search
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Title: JS-ADMIN-README
Abstract: An ultra-basic README for JabberStudio admins.
Author: stpeter
Version: 0.1
Last Updated: 2005-10-14
There are two main tasks related to JabberStudio administration:
There are two main tasks related to JabberStudio administration:


1. Creating new JS users on zeus
= Creating new JS users on zeus =
2. Creating new JS projects
 
1.0 CREATING JS USERS
 
Web users are different from system users. Developers need to be
Web users are different from system users. Developers need to be
system users with a shell account on zeus in order to check in
system users with a shell account on zeus in order to check in
Line 17: Line 7:
users:
users:


- Log into zeus (you're soaking in it)
* Log into zeus (you're soaking in it)
- Type 'jsadduser username email' (make the system name the same as the person's JS web username if possible)
* Type 'jsadduser username email' (make the system name the same as the person's JS web username if possible, it just makes life easier)
- When prompted, type the person's Full Name
* When prompted, type the person's Full Name
- Skip the Room Number, Work Phone, and Home Phone
* Skip the Room Number, Work Phone, and Home Phone
- For Other, type the person's email address
* For Other, type the person's email address


When you're done, the jsadduser script will send an email to the
When you're done, the jsadduser script will send an email to the
new shell user.
new shell user.


2.0 CREATING JS PROJECTS
= Creating JS Projects =


This is a two-part process: you need to access the web interface and
This is a two-part process: you need to access the web interface and
Line 34: Line 24:
Note: I tend to "interview" the project requester via Jabber because
Note: I tend to "interview" the project requester via Jabber because
sometimes people are confused about whether they even really need a
sometimes people are confused about whether they even really need a
JabberStudio project. Also, several years ago, temas and I decided that
JabberStudio project, they're not ready to check in code and don't know what license to use, etc. Also, several years ago, temas and I decided that
JS is for hosted projects only (projects that check in code), not the
JS is for hosted projects only (projects that check in code), not the
old-style projects that point to code elsewhere. Remember, JS is like
old-style projects that point to code elsewhere. Remember, JS is like
Line 41: Line 31:
OK, here goes:
OK, here goes:


- Log into http://www.jabberstudio.org/
* Log into http://www.jabberstudio.org/
- Click the "Site Administration" link at the top right
* Click the "Site Administration" link at the top right
- Click "Add A Project" from the "Site Admin" menu
* Click "Add A Project" from the "Site Admin" menu
- Fill out the form as follows:
* Fill out the form as follows:
  - Project Name: this is the friendly name, can contain spaces etc.
** Project Name: this is the friendly name, can contain spaces etc.
  - System Name: this is the system name, no spaces or caps etc.
** System Name: this is the system name, no spaces or caps etc.
  - Owner: this is the project owner's web username, not system username
** Owner: this is the project owner's web username, not system username
  - Homepage: http://projectname.jabberstudio.org/ or URL of project owner's
** Homepage: http://projectname.jabberstudio.org/ or URL of project owner's choice
    choice
** Content Management URL: leave it blank (I don't know what this is for!)
  - Content Management URL: leave it blank *
** Description: Project description as provided by project owner, edit as necessary (I always do!)
  - Description: Project description as provided by project owner, edit as
** Type: Normal
    necessary (I always do!)
** License: FOSS license for project code (if you need to add a new one, ping me)
  - Type: Normal
** Platforms: General unless a client, then choose appropriate computing platform (if you need to add a new one, ping me)
  - License: FOSS license for project code (if you need to add a new one,
** Programming Language: Main code language for project code
    ping me)
** Category: Choose one
  - Platforms: General unless a client, then choose appropriate computing
** Allow Anonymous Comments: uncheck (I don't know what this is for!)
    platform (if you need to add a new one, ping me)
** Allow Anonymous Submissions: uncheck (I don't know what this is for!)
  - Programming Language: Main code language for project code
  - Category: Choose one
  - Allow Anonymous Comments: uncheck *
  - Allow Anonymous Submissions: uncheck *
 
* I don't know what these are for!


Now, BEFORE you hit the "Add" button, do the following!
Now, BEFORE you hit the "Add" button, do the following!


1. Double-check the form
# Double-check the form
2. Run the jsaddproject script:
# Run the jsaddproject script:


   jsaddproject project-name owner-shell-account email-address group-name
   jsaddproject project-name owner-shell-account email-address group-name


  Where...
Where...
 
* project-name = short system name from web form
* owner-shell-account = project owner's shell account name from jsadduser
* email-address = project owner's email address
* group-name = short group name to be added to /etc/group (usually this is just the same as the project-name)
 
If the jsaddproject script completes with no errors, the project owner will receive a helpful and informative email and it will be safe for you to hit the "Add" button on the "Add A Project" page.
 
That's it!


  - project-name = short system name from web form
= Other Tasks =
  - owner-shell-account = project owner's shell account name from jsadduser
  - email-address = project owner's email address
  - group-name = short group name to be added to /etc/group (usually this is
    just the same as the project-name)


END
Mailing list setup etc. to follow.

Latest revision as of 21:25, 14 October 2005

There are two main tasks related to JabberStudio administration:

Creating new JS users on zeus

Web users are different from system users. Developers need to be system users with a shell account on zeus in order to check in code and modify their project websites. Here's how to create system users:

  • Log into zeus (you're soaking in it)
  • Type 'jsadduser username email' (make the system name the same as the person's JS web username if possible, it just makes life easier)
  • When prompted, type the person's Full Name
  • Skip the Room Number, Work Phone, and Home Phone
  • For Other, type the person's email address

When you're done, the jsadduser script will send an email to the new shell user.

Creating JS Projects

This is a two-part process: you need to access the web interface and also run the jsaddproject script on zeus. You MUST run the jsaddproject script before you hit the "Add" button on the "Add A Project" page!

Note: I tend to "interview" the project requester via Jabber because sometimes people are confused about whether they even really need a JabberStudio project, they're not ready to check in code and don't know what license to use, etc. Also, several years ago, temas and I decided that JS is for hosted projects only (projects that check in code), not the old-style projects that point to code elsewhere. Remember, JS is like SourceForge, not Freshmeat.

OK, here goes:

  • Log into http://www.jabberstudio.org/
  • Click the "Site Administration" link at the top right
  • Click "Add A Project" from the "Site Admin" menu
  • Fill out the form as follows:
    • Project Name: this is the friendly name, can contain spaces etc.
    • System Name: this is the system name, no spaces or caps etc.
    • Owner: this is the project owner's web username, not system username
    • Homepage: http://projectname.jabberstudio.org/ or URL of project owner's choice
    • Content Management URL: leave it blank (I don't know what this is for!)
    • Description: Project description as provided by project owner, edit as necessary (I always do!)
    • Type: Normal
    • License: FOSS license for project code (if you need to add a new one, ping me)
    • Platforms: General unless a client, then choose appropriate computing platform (if you need to add a new one, ping me)
    • Programming Language: Main code language for project code
    • Category: Choose one
    • Allow Anonymous Comments: uncheck (I don't know what this is for!)
    • Allow Anonymous Submissions: uncheck (I don't know what this is for!)

Now, BEFORE you hit the "Add" button, do the following!

  1. Double-check the form
  2. Run the jsaddproject script:
  jsaddproject project-name owner-shell-account email-address group-name

Where...

  • project-name = short system name from web form
  • owner-shell-account = project owner's shell account name from jsadduser
  • email-address = project owner's email address
  • group-name = short group name to be added to /etc/group (usually this is just the same as the project-name)

If the jsaddproject script completes with no errors, the project owner will receive a helpful and informative email and it will be safe for you to hit the "Add" button on the "Add A Project" page.

That's it!

Other Tasks

Mailing list setup etc. to follow.