View source for Dreamhack Getting Started

The [http://hack.dreamwidth.net Dreamhack] service is a hosted development sandbox environment where you can do Dreamwidth development without having to have your own server. Dreamhack accounts are available free of charge for anyone who's interested in working on the Dreamwidth code.

When you get your Dreamhack account first created, most of the setup will be done for you. There are still a bunch of things you should do at first to make sure that your development environment is properly set up for you to work on, though. This guide is a walkthrough of all the steps you should take (in order) when you first log into your Dreamhack account. 

You should also read [[Beginning dev checklist]] for more background information; if you are on Windows, [[Newbie Guide: Getting Started on Windows]] might be useful. If you wind up in difficulty, take a look at [[Dreamhack Troubleshooting]].

== Basic setup ==

=== Get a SSH client ===

To connect to your Dreamhack and work on things, you'll need a program that will do SSH, or "secure shell". It lets you connect to the Dreamhack server and work with the files, which you can't do through your browser. If you're running Windows, download [http://www.chiark.greenend.org.uk/~sgtatham/putty/ PuTTY]. If you're on a Mac or a Linux distribution, you won't need a separate program; the Terminal (Applications/Utilities/Terminal on the Mac) will let you connect. If you're on a Mac, you can also [[Connecting_to_the_Dreamhack_server_with_Cyberduck | use Cyberduck]].

=== Connect to your Dreamhack ===

Once you have an SSH client, you can connect to Dreamhack. In PuTTY, put "ssh-hack.dreamwidth.net" for the server, and use the username and password you were given in your welcome email. In Terminal, type:

<source lang="bash">ssh dh-username@ssh-hack.dreamwidth.net</source>

If this is the first time you've connected to the server, your SSH client will inform you that it hasn't seen this host before, and ask you to verify the fingerprint of the host key. For '''ssh-hack.dreamwidth.net''', this fingerprint will show one of the following, depending on your SSH client:

* <tt>SHA256:TAtO07wp/zu1L4lIoYPnJh9pficQUcBsl9aqZiEM6UE</tt>
* <tt>SHA256:jU9iFXflDW/FMRAFDaR0HMZ3zwsNxBa333A4Pl7ys1w</tt>
* <tt>73:10:37:bc:47:4b:24:dc:50:5f:7e:af:f7:b4:a0:b6</tt>
* <tt>29:18:e9:63:c5:b5:79:5c:bd:d6:3b:63:ce:7a:83:85</tt>

Compare the fingerprint to what you see above, and if one of the above fingerprints match, click (or type) "Yes" to connect. If you do ''not'' see the fingerprint listed above, please contact Sophira on [[IRC]] or by email.

=== Change your password ===

Change your password to something you can remember. Type:

<source lang="bash">passwd</source>

and follow the prompts.

=== Set the system password ===

Your Dreamhack installation has a user named 'system', which has all the admin privs and owns all the system styles. The system account is the first account on the server. You need to set a password so you can log into it. Type:

<source lang="bash">$LJHOME/bin/upgrading/make_system.pl</source>

Pick something you'll remember. (If you ever forget the system password, though, you can just run make_system.pl again and re-set it.)

=== Get acquainted with the command line ===

If you haven't used a command line before, it can be a strange experience. You may want to check out the [[Command line tutorial]] before carrying on, as it explains a few of the concepts that we'll be using in the sections below.

=== Edit the config files ===

You'll need to edit a few config files to make for easier development. Do the following:

<source lang="bash">cd $LJHOME
cp etc/config.pl.example etc/config.pl
nano etc/config.pl</source>

(The "nano" text editor is probably the best one for new developers. If you're more experienced, or want to try something a little more powerful, check out the list of editors at the [[Configuring editors]] page.)

You'll need to use the arrow keys to scroll through the file when using nano, because it won't respond to the mouse.

Take a look for the following line:

<source lang="bash">$USE_ACCT_CODES = 1;</source>

This line governs whether invite codes are used. If the value is 1, then new accounts will need invites before they can be created. If the value is 0, then anybody can create an account. You can edit this value, if you like.

When you're done, press Ctrl-X to exit nano. It'll ask you if you want to save - press Y. It'll then ask you where you want to save the file. At this point, just press RETURN; you already told nano where to save it when you launched it, and pressing RETURN tells nano just to use that. You'll then find yourself back at the command line.

You should also edit your <tt>$LJHOME/ext/local/etc/config-local.pl</tt> file for some other local settings:

<source lang="bash">cd $LJHOME
nano -w ext/local/etc/config-local.pl</source>

Values you may want to change and/or set:

<source lang="bash">$SITENAME = "Some LiveJournal Site";
$SITENAMESHORT = "YourSite";
$SITENAMEABBREV = "YS";
# these are all used in various places throughout the site</source>

Remember to save and exit when you're done.

=== Start Apache ===

Once all of this is done, you're ready to start Apache. Type:

<source lang="bash">start-apache</source>

Your Dreamhack will now appear at http://www.yourusername.hack.dreamwidth.net.

=== Hack away! ===

You can now start hacking! For more information, check out the [[:Category: Development]] category, especially the [[Beginning dev checklist]], [[Dev Getting Started]], and [[Programming Guidelines]] pages. If you run into problems, the [irc://irc.freenode.net/dreamwidth-dev #dreamwidth-dev] [[IRC]] channel and the <dwcomm>dw_dev_training</dwcomm> community are good places to go for help. 

A quick and easy way to populate your Dreamhack with lots of users is to run Sophie's [[Script:_create-users]].

We're looking forward to seeing your first patch!

=== Stop Apache ===

At the end of a Dreamhack session, remember to <code>stop-apache</code> so that the Dreamhack machine isn't running too many web servers that aren't being used.

== Extended Setup ==

=== Configuring BlobStore ===

If you want to upload user icons, or if you see any errors of the form <b><code>Must configure @LJ::BLOBSTORES</code></b> in your logs, then you will need to configure [[BlobStore]] on your Dreamhack. 

Dreamwidth uses S3 in production for data storage, but a development environment can use local disk storage instead. To set it up, edit your <code>~/dw/ext/local/etc/config-private.pl</code> file and uncomment these lines:

<source lang=perl>
     @BLOBSTORES = (
         # Local disk configuration, can be used to store everything on one machine
         localdisk => {
             path => "$LJ::HOME/var/blobstore",
         },
     );
</source>

Save the file and restart apache for these changes to take effect.

== Tips and Advice ==

=== Update your code regularly ===

Before you do any development work, it's a good idea to update your code to the most recent version. See [[Dev Maintenance]] for instructions.

=== Get familiar with version control ===

Browse through [[Git How To]] and get familiar with how things work -- bookmark it so you can refer back to each section as needed.

=== A note about workers ===

Some features run asynchronously. That means they don't happen immediately when they are fired off. Instead, they get queued up to run later via [[Workers]], at pre-programmed periods of time.

Features that run asynchronously via workers are either:
* process heavy, such as search and notifications, or
* require communication with remote sites we don't control, such as crossposts and imports.

If you aren't working on these features, then you don't need to worry about workers.

If you are working on these features, there are two different kinds of workers: [[TheSchwartz]] and [[Gearman]]. If you need them, recent Dreamhacks are already set up to let you use TheSchwartz (and Gearman?). If your Dreamhack is very old you can set up the TheSchwartz database using:

<source lang="bash">$LJHOME/bin/ljdb < /usr/share/doc/libtheschwartz-perl/schema.sql</source>

then restarting Apache.

[[Category:Development]]
[[Category:Dreamhack]]
[[Category:Getting Started]]