Update README for archival
[reddit.git] / install / done.sh
blob4cd9bf668e2f6b4ac2a6612e78f1e1350598f677
1 #!/bin/bash
2 # The contents of this file are subject to the Common Public Attribution
3 # License Version 1.0. (the "License"); you may not use this file except in
4 # compliance with the License. You may obtain a copy of the License at
5 # http://code.reddit.com/LICENSE. The License is based on the Mozilla Public
6 # License Version 1.1, but Sections 14 and 15 have been added to cover use of
7 # software over a computer network and provide for limited attribution for the
8 # Original Developer. In addition, Exhibit A has been modified to be consistent
9 # with Exhibit B.
11 # Software distributed under the License is distributed on an "AS IS" basis,
12 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
13 # the specific language governing rights and limitations under the License.
15 # The Original Code is reddit.
17 # The Original Developer is the Initial Developer. The Initial Developer of
18 # the Original Code is reddit Inc.
20 # All portions of the code written by reddit are Copyright (c) 2006-2015 reddit
21 # Inc. All Rights Reserved.
22 ###############################################################################
24 # load configuration
25 RUNDIR=$(dirname $0)
26 source $RUNDIR/install.cfg
28 ###############################################################################
29 # All done!
30 ###############################################################################
31 cat <<CONCLUSION
33 Congratulations! reddit is now installed.
35 The reddit application code is managed with upstart, to see what's currently
36 running, run
38 sudo initctl list | grep reddit
40 Cron jobs start with "reddit-job-" and queue processors start with
41 "reddit-consumer-". The crons are managed by /etc/cron.d/reddit. You can
42 initiate a restart of all the consumers by running:
44 sudo reddit-restart
46 or target specific ones:
48 sudo reddit-restart scraper_q
50 See the GitHub wiki for more information on these jobs:
52 * https://github.com/reddit/reddit/wiki/Cron-jobs
53 * https://github.com/reddit/reddit/wiki/Services
55 The reddit code can be shut down or started up with
57 sudo reddit-stop
58 sudo reddit-start
60 And if you think caching might be hurting you, you can flush memcache with
62 reddit-flush
64 Now that the core of reddit is installed, you may want to do some additional
65 steps:
67 * Ensure that $REDDIT_DOMAIN resolves to this machine.
69 * To populate the database with test data, run:
71 cd $REDDIT_SRC/reddit
72 reddit-run scripts/inject_test_data.py -c 'inject_test_data()'
74 * Manually run reddit-job-update_reddits immediately after populating the db
75 or adding your own subreddits.
76 CONCLUSION