Difference between revisions of "Archive:Website documentation"
Latest revision as of 00:31, 12 August 2016
- 1 The layout/styling/look of the main website and chapter websites
- 2 Mailing lists
- 3 Email Forwarding
- 4 Chapter hosting
- 4.1 Chapter Blogs
- 4.2 The Chapter Database
- 4.3 The Chapter News Feed (and the personal Planet)
- 4.4 The Front Page
- 4.5 Cron
- 5 Databases
- 6 Subversion
- 7 Backups
- 8 Monitoring
- 9 Wiki
- 10 Passwords
- 11 Where the heck are the files for the part of the website that I'm working on?
- 12 here is a step-by-step description of how to make changes to our live Wordpress theme, by Nelson
The layout/styling/look of the main website and chapter websites
The main website and chapter websites are served by wordpress, from this directory:
The themes live here:
The main blog uses:
If you make edits on the live site, they won't show up right away!
Why? Because we use a caching plugin for wordpress, which means that your edits to the php files aren't immediately added to the cached html files that the server serves. The best way to refresh the cache is to make an edit to a static page (just add a line break at the bottom or something).
When you edit the main site theme, you really should use version control
See #Subversion. However, don't let this be a total blocker. Just please do let the webteam know when you make live edits that haven't been checked in, so that someone else can check them in.
You can even make live edits right from your web browser
Your account on our wordpress install will need permissions to access the "network" dashboard. Then you just go here. Again, please make sure that your edits are checked in to version control.
We use Mailman to manage our lists.
I just want to subscribe to mailing list X
(For illustrated instructions, see the page about our Fc-discuss listserv!)
- Go here
- Find mailing list X
- Click on it
- Enter your email address and name in the "Subscribing to X" section
- Press "Subscribe"
- That's it.
I want to do something that's more like list management
The password is usually listed in /home/freecult/passwords/mailman You can access that file by connecting through SSH or SFTP. If that doesn't work or you don't know how to access that, contact User:Gameguy43 to get the right password.
I want to make a new mailing list
- Do that here
- Leave the field for the list password blank, selecting the option to have a new list password generated automatically
- The main mailman password will always work on this list
- The last field, called "List creator's (authentication) password" is where you enter the password described above
I want to do something else, AKA Generally Useful Links
I want to subscribe someone easily, from the command line
create a script subscribe.sh that looks something like this:
ssh email@example.com "cd /usr/lib/mailman/bin ; echo $1 | sudo python /usr/lib/mailman/bin/add_members -r - -w y -a y discuss"
To set up forwarding from firstname.lastname@example.org to email@example.com:
- $ adduser address (if the user doesn't already exist)
- edit ~address/.procmailrc to read something like this:
:0c ! firstname.lastname@example.org
The "c" stands for copy. That's key - they stay in the IMAP box.
We have a secret gmail account, freeculture.org at gmail dot com, that receives copies of the email sent to freedom, newgroup, and media. This was built to solve . The password for this secret account can be found in ~freecult/passwords, like most other passwords.
Because each of those email addresses is a separate account, they have a .procmailrc in their $HOME that reads:
:0c ! email@example.com
Chapter blogs are hosted on our WordpressMU install (which is now just called Wordpress). These files live here:
So that means that the themes live here:
Where is the admin interface?
Making a new blog
To create a new blog, you need a "site admin" account.
For that to happen, someone who has one needs to add your username to: http://wpmu.freeculture.org/wp-admin/wpmu-options.php In the field "Site Admins" at the very bottom of the page.
How do I know I'm a site admin?
When you log in here, you'll see a widget in your sidebar called "Site Admin."
So how do I do it already?
- Fill in the form here. Put the chapter leader's contact info (or whoever it is that you're interfacing with to make their website) in the "Admin Email" field.
But the site won't be visible until you do this:
- Edit /etc/apache2/conf.d/400-wpmu.conf. Probably you'll want to enter a command like this:
sudo nano /etc/apache2/conf.d/400-wpmu.conf
Add a line like this:
Where chaptername is the blog subdomain, as you entered it when you created the blog
- run this:
sudo /etc/init.d/apache2 reload
We should document this.
There are a bunch of Deprecated chapter hosting notes, including stuff about chapter wikis
The Chapter Database
It lives in a google spreadsheet. A python script runs nightly (or so) and slurps out the data and drops it in to freeculture.org/chapters.json. to run this script on demand, do this:
The Chapter News Feed (and the personal Planet)
The planet program lives in ~/planet-prog/. It outputs to ~/public_html/planet/ via an every-30m cron job.
There are two planets. They share the same Python code; they just have different config.ini directories:
Add people's RSS feeds to those config files according to the comments you'll find inside. For the people Planet, add people's mini-photos in ~/domains/planet.freeculture.org/images/ and adjust the config.ini as appropriate. For the chapters Planet, I have no idea.
You might consider backing up all of the files to the .backup directory before making changes.
You could try upgrading it using "bzr". I wouldn't try it without backing up ~/planet-prog/. I expect it to clobber ~/planet-prog/examples/fancy/config.ini.
LiveJournal, for example, has broken RSS feeds that sometimes give the wrong Last-Modified-Date. So you might need to ask Planet to redownload the whole feed.
According to ~/planet-prog/examples/fancy/config.ini , Planet stores its cache in ~/planet-prog/cache/ . So to delete the whole cache:
In that directory, you can choose to remove just a single cached feed. The names make it clear which one is which.
The Front Page
How does the actual FreeCulture.org homepage get produced? What does everyone see when they visit http://freeculture.org ?
Since we have moved the site into Wordpress, most of our code can be found in the Wordpress theme "fco-wordpress-theme" in "~/domains/freeculture.org/wp-content/themes/". The skeleton for the front page is found in "front_page.php", which gets the content from functions found in "fco-wordpress-theme/front_page/". For instance, the "blurb" at the top of the front page (currently "Students for Free Culture is an international chapter-based student organization that promotes the public interest in intellectual property and information & communications technology policy.") can be found in "fco-wordpress-theme/front_page/front_page_code.php".
The content for the "Current Campaign" box does not come from the theme, it is what you see if you try to open the front page in the Wordpress page editor... it is intended to be easily edited and updated through the GUI just like any other blog page.
We use cron to run tasks every once in a while. To see the current list of jobs that run, do:
To edit them:
To see what the file format is, read this reference.
- Visit https://secure.makesad.us/~admin/intranet/mysql_tools/make_db.html from the fc.o server, and enter some username freecult_something and click "Submit"! (the username / db name should be less than 16 characters in length)
- When you create a new database, be sure to BACK IT UP (see section backups)
- You can not use PHPMyAdmin to view our databases.
- svn checkout http://freeculture.org:8080/svn/
- Just do "svn commit"!
- But you must be a registered user first, see below!
- Log in to the freeculture.org server, and do:
htpasswd /home/freecult/subversion-repository/conf/htpasswd YOUR_USERNAME
- Your password will not be encrypted when sent across the Internet, so keep that in mind when picking the password.
Asheesh set up 'dirvish' and configured his work desktop to pull the backups from the fco vserver.
Every night, a cron job runs that saves all the databases to separate files in /home/freecult/backups/databases/. These are then copied as regular files during the nightly dirvish backup job.
To get a database in on this super fun backup party (everyone's doing it), add it to /home/freecult/passwords/mysql_passwords
We have monitoring by cyberspark.net Parker and Asheesh get the emails.
Data privacy on this wiki
We ask users to store personal information in this wiki. Here are all the ways we restrict access to it:
- TODO: Non-includable namespaces: NS_USER should be blocked from being transcluded.
- DONE: Semantic MediaWiki currently does not store properties whose names begin with secret_.
- FIXME: It should store the data and just not show it unless you're an admin.
- TODO: Choose some MW extension to prevent people from reading source of NS_USER pages.
- In practice, the "read" right allows viewing the source. Therefore, we will have to:
- Prevent non-owners of an NS_USER page from changing that user's page, and
- Around line 1077, change the $source to a message indicating data has been hidden from view for privacy reasons, and
- Prevent the DifferenceEngine from showing these pages.
- Main call is Article.php:661, but just grep for new.*DifferenceEngine
- In practice, the "read" right allows viewing the source. Therefore, we will have to:
Review of UserCan extensions
Which MW extension can easily prevent people from writing each others' NS_USER pages?
- NOT Read Restrict - this isn't tested against the possible security holes.
- NOT UserPageEditProtection - no discussion of view source.
- NOT WhiteList - whitelisting isn't what we want.
- NOT Prefix security - requires manual group maintenance.
- NOT PermissionACL - requires manual group maintenance.
- NOT PasswordProtected- wrong model
Hmm. From #mediawiki moments ago:
<paulproteus> I want pages that people can read but can't view the source of, to be clear. <Simetrical> paulproteus, it controls all view permissions, including view source. <paulproteus> I see. <Simetrical> You can't have that.
Upgrading Semantic MediaWiki
If you feel motivated to upgrade Semantic MediaWiki or Semantic Forms, you should be sure to update the SMW data set. Here's how:
$ cd domains/wiki.freeculture.org/maintenance/ $ php SMW_refreshData.php -pv $ php SMW_refreshData.php -v
DEPRECATED: Every domain we own or run is listed at Domains.
DEPRECATED--as far as I know, we don't do this anymore --Parker, oct 16th 2010.
We use phpicalendar. If everyone working on the national level shares their calendars with each other, it becomes much easier to schedule meetings at mutually convenient times (instead of playing calendar battleship... "are you free at 3pm?" "No." "How about 4pm?" "You sunk my battleship! You bastard!").
As a user
- Set your calendar client to synchronize to http://freeculture.org:8080/calendars/YOURNAMEHERE.ics
- You will need to use a username/password pair special to the calendar stuff assigned to you by the web team
- Be SURE you use a file with your name in it. Otherwise you run the risk of others overwriting your data, and vice-versa!
- Check on http://freeculture.org/cal/ that your calendar appears
As a sysadmin
- Apache2 runs the WebDAV service; its configuration is in /etc/apache2/
- htpasswd file in ~freecult/passwords/calendar-htpasswd
- calendar files stored in ~freecult/public_html/database/calendars/
- to change someone's password, or create a user, do:
htpasswd /home/freecult/passwords/calendar-htpasswd USERNAME
We keep them all in ~freecult/passwords/
Where the heck are the files for the part of the website that I'm working on?
The main blog and chapter hosting are served by a wordpress install out of:
But most other things are served out of:
here is a step-by-step description of how to make changes to our live Wordpress theme, by Nelson
- You must be able to SSH into the server as both firstname.lastname@example.org and email@example.com. To gain this power, someone who already has this power must put your SSH public key into the freecult@ and chapterhosting@ authorized keys files. (We prefer RSA encryption over DSA)
- You must add yourself as an svn user, by SSHing into the server as freecult and executing this command:
- htpasswd /home/freecult/subversion-repository/conf/htpasswd YOUR_USERNAME
- It will fail if you are not logged in as freecult b/c freecult owns those files.
- Check out our SVN repository by running this command on your local machine:
- svn checkout http://freeculture.org:8080/svn/
- Make your changes to "wordpress-theme" in your SVN checkout
- Do an "svn commit" on your machine, such as:
- svn commit --message "This should fix the admin bar bug" --user myusername --password mypassword
- If your username on your UNIX system is different from your SVN username, the --user option is necessary, the --password option is not necessary, it will prompt you for your password if you don't put it on the command line.
- SSH into the server as chapterhosting and go to the directory where the live theme lives:
- cd wordpress-mu/wp-content/themes/fco-wordpress-theme
- Do an "svn up" to pull the changes from your local repository.
Ta da! Your changes should be live on the website now! That wasn't that hard was it? OK, maybe it was.