Skip to content
Newer
Older
100644 135 lines (75 sloc) 5.64 KB
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
1 # Diaspora
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
2
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored Sep 11, 2010
3 The privacy aware, personally controlled, do-it-all, open source social network.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
4
259143b disclaimer
Daniel Vincent Grippi authored Sep 14, 2010
5 **DISCLAIMER: THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
fa947b1 minor changes
Daniel Vincent Grippi authored Sep 14, 2010
6 These instructions are designed for machines running [Ubuntu](http://www.ubuntu.com/) or Mac OS X.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
7
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
8 ## Preparing your system
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
9 In order to run Diaspora, you will need to download the following dependencies (specific instructions follow):
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
10
fa947b1 minor changes
Daniel Vincent Grippi authored Sep 15, 2010
11 - [Ruby](http://www.ruby-lang.org) - The Ruby programming language. (We're using 1.8. It comes preinstalled on Mac OS X.)
4d7d937 updates to readme
Daniel Vincent Grippi authored Sep 14, 2010
12 - [MongoDB](http://www.mongodb.org) - A snappy noSQL database.
fa947b1 minor changes
Daniel Vincent Grippi authored Sep 15, 2010
13 - [OpenSSL](http://www.openssl.org/) - An encryption implementation. (It comes preinstalled on Mac OS X and later versions of Ubuntu.)
4d7d937 updates to readme
Daniel Vincent Grippi authored Sep 14, 2010
14 - [ImageMagick](http://www.imagemagick.org/) - An Image processing library used to resize uploaded photos.
15 - [Git](http://git-scm.com/) - The fast version controll system.
16
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
17 After you have Ruby installed on your system, you will need to get Rubygems, then install Bundler:
4d7d937 updates to readme
Daniel Vincent Grippi authored Sep 14, 2010
18
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
19 - [RubyGems](http://rubygems.org/) - Source for Ruby gems.
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored Sep 11, 2010
20 - [Bundler](http://gembundler.com/) - Gem management tool for Ruby projects.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
21
fa947b1 minor changes
Daniel Vincent Grippi authored Sep 15, 2010
22 **We suggest using a package management system to download these dependencies. Trust us, it's going to make your life a lot easier. If you're using Mac OS X, you can use [homebrew](http://mxcl.github.com/homebrew/); and if you're using Ubuntu, just use [Synaptic](http://www.nongnu.org/synaptic/) (it comes pre-installed). The below instructions assume you have these installed.**
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
23
24 ### Ruby
25
26 To install Ruby 1.8.7 on **Ubuntu**, run the following command:
27
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 14, 2010
28 sudo apt-get install ruby-full
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
29
30 If you're on **Mac OS X**, you already have Ruby on your system. Yay!
31
32 ### MongoDB
33
34 To install MongoDB on **Ubuntu**, run the following commands:
35
36
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
37 If you're running a 32-bit system, run `wget http://fastdl.mongodb.org/linux/mongodb-linux-i686-1.6.2.tgz`. If you're running a 64-bit system, run `wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-1.6.2.tgz`.
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
38
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
39 # extract
40 tar xzf mongodb-linux-i686-1.4.0.tgz
41 # create the required data directory
42 sudo mkdir -p /data/db
43 sudo chmod -Rv 777 /data/
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
44
45
46 To install MongoDB on **Mac OS X**, run the following:
47
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
48 brew install mongo
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
49
50 ### OpenSSL
51
52 If you're running either **Ubuntu** or **Mac OS X** you already have OpenSSL installed!
53
54 ### ImageMagick
55
56 To install ImageMagick on **Ubuntu**, run the following:
57
fa947b1 minor changes
Daniel Vincent Grippi authored Sep 15, 2010
58 sudo apt-get install imagemagick libmagick9-dev
59
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
60 To install ImageMagick on **Mac OS X**, run the following:
61
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
62 brew install imagemagick
63
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
64 ### Git
65
66 To install Git on **Ubuntu**, run the following:
67
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
68 sudo apt-get install git-core
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
69
70 To install Git on **Mac OS X**, run the following:
71
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
72 brew install git
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
73
74
75 ### Rubygems
76
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
77 On **Ubuntu**, run the following:
78
79 wget http://production.cf.rubygems.org/rubygems/rubygems-1.3.7.tgz
80 tar -xf rubygems-1.3.7.tgz
81 cd rubygems-1.3.7
82 sudo ruby setup.rb
83 sudo ln -s /usr/bin/gem1.8 /usr/bin/gem
84
85 On **Mac OS X**, RubyGems comes preinstalled; however, you might need to update it for use with the latest Bundler. To update RubyGems, run `gem update --system`.
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
86
87
88 ### Bundler
89
fb9d504 more instructions
Daniel Vincent Grippi authored Sep 15, 2010
90 After RubyGems is updated, simply run `gem install bundler` to get Bundler.
a5c86ac testing markup
Daniel Vincent Grippi authored Sep 14, 2010
91
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
92
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
93 ## Getting Diaspora
4d7d937 updates to readme
Daniel Vincent Grippi authored Sep 14, 2010
94 To download Diaspora, you will want to clone it from the official github repository [here](http://github.com/diaspora/diaspora). If you have never used github before, their [help desk](http://help.github.com/) has a pretty awesome guide on getting setup[.](http://www.youtube.com/watch?v=OQSNhk5ICTI)
95
96
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
97 ## Running Diaspora
4d7d937 updates to readme
Daniel Vincent Grippi authored Sep 14, 2010
98
fa947b1 minor changes
Daniel Vincent Grippi authored Sep 15, 2010
99 ### Install required gems
100 In order to start the app server for the **first time**, bundler needs to grab Diaspora's gem depencencies. To allow this, run `bundle install` from Diaspora's root directory.
101
102 It is important to run a bundle install every so often, in the event of a new gem dependency. We will make sure to make an announcement in the event of a gem change.
103
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
104 ### Start Mongo
105 After installing the above, run `sudo mongod` from where mongo is installed to start mongo.
106
4d7d937 updates to readme
Daniel Vincent Grippi authored Sep 14, 2010
107 Diaspora will **not run** unless mongo is running. Mongo will not run by default, and will need to be started every time you wish to use or run the test suite for Diaspora.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
108
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
109 ### Run the app server
fa947b1 minor changes
Daniel Vincent Grippi authored Sep 15, 2010
110 Once mongo is running and bundler has finished, run `bundle exec thin start` from the root Diaspora directory. This will start the app server in development mode.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
111
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
112 ### Testing
113 Diaspora's test suite uses [rspec](http://rspec.info/), a behavior driven testing framework. In order to run the tests, run `bundle exec rspec spec`.
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
114
115
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
116 ## Getting Help
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
117 There are multiple outlets of ongoing discussion on the development of Diaspora.
118
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored Sep 11, 2010
119 - [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
120 - [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
121 - [#diaspora-dev](irc://irc.freenode.net/#diaspora-dev)
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
122
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored Sep 11, 2010
123 More general info and updates about the project can be found on our [blog](http://joindiaspora.com), [twitter](http://twitter.com/joindiaspora). Also, be sure to join the official [mailing list](http://http://eepurl.com/Vebk).
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored Sep 11, 2010
124
95169a2 added agpl license to readme
Daniel Vincent Grippi authored Sep 14, 2010
125
2c2cc9c atx-style headers
Daniel Vincent Grippi authored Sep 14, 2010
126 ## License
95169a2 added agpl license to readme
Daniel Vincent Grippi authored Sep 14, 2010
127 Copyright 2010 Diaspora Inc.
128
129 Diaspora is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
130
131 Diaspora is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
132
133 You should have received a copy of the GNU Affero General Public License along with Diaspora. If not, see <http://www.gnu.org/licenses/>.
134
Something went wrong with that request. Please try again.