Commit Graph

333 Commits

Author SHA1 Message Date
NCLS a1cfdf65e5 Fix grammar mistake (#566) 2018-03-09 18:38:06 +01:00
NCLS 711dfc4fa7 Fix small typo (#565) 2018-03-09 17:34:21 +01:00
NCLS fdc409d2df Add Elasticsearch Guide (#564)
* Add initial elasticsearch guide

* Add elasticsearch guide link to README.md

* Add chewy:deploy
2018-03-09 17:15:17 +01:00
Eugen Rochko 5107618bdd Update production guide in preparation for 2.3.0 (#562)
* Update production guide in preparation for 2.3.0

* Update Production-guide.md
2018-03-09 12:14:14 +01:00
Eugen Rochko 85b4343e07
Update Administration-guide.md 2018-03-09 12:04:45 +01:00
Eugen Rochko ceaa847cbb
Update Docker guide in preparation for 2.3.0 (#561) 2018-03-09 11:56:08 +01:00
Akihiko Odaki 845ed4ad99 Use db:setup instead of db:migrate when creating the database (#560)
db:setup is used in all guides except Docker Guide, which uses db:migrate
to create the database. db:setup is actually superior over db:migrate for
the purpose in terms of performance and compatibility.

db:setup is performant because it does not perform redundant migrations.
db:migrate, on the other hand, executes migration code which will be
dismissed by later migrations. db:migrate also waits for seconds to allow
to interrupt migrations if it is not favorable to run them on a running
server, but db:setup is obviously executed on a instance which is not
running yet, and the wait is unnecessary.

db:migrate has a compatibility issue. It requires a compatibility layer
to keep it working, and such one may be broken, or not provided by
dependencies such as Paperclip.

This commit replaces db:migrate with db:setup in the building guide. The
procedure cannot be applied to migration from an older release, where
the old procedure could, but it is not problematic because it has
dedicated Updating section.
2018-03-09 06:41:01 +01:00
Treyssat-Vincent Nino dbd39f7f1e Typo in List-of-Rake-tasks.md (#559) 2018-03-08 13:08:14 +01:00
Eugen Rochko 5bf91ce594
Add information about HTML formatting in admin settings 2018-03-08 08:39:46 +01:00
Eugen Rochko c1af30a86b
LDAP_ENABLED no longer required outside of .env 2018-03-07 12:23:00 +01:00
Hugh Cole-Baker 6fd155d7a7 Add documentation on how to use LDAP for logins (#554) 2018-03-04 20:43:13 +01:00
Paul Woolcock d97b67a913 Update List-of-Rake-tasks.md (#551)
add the `redownload_avatars` task
2018-02-26 17:43:56 +01:00
Ian McCowan e191c374e4 Update Mac instructions to 2.5 (#544) 2018-02-18 02:11:19 +01:00
Angristan 2e86bdaf2c Tiny improvements (#539) 2018-02-11 19:27:53 +01:00
Eugen Rochko 9d1505a3e0
Revert "Removes SSL configuration to point users to the Mozilla SSL Configuration Generator" (#475)
This reverts commit 9474170686.
2018-02-10 23:18:01 +01:00
Eugen Rochko 3e49e71fd2
Revert "Add libpam0g-dev to Ubuntu package dependencies" (#536)
* Revert "Enabled bundler multicore support (#529)"

This reverts commit acaea9251f.

* Revert "Add libpam0g-dev to Ubuntu package dependencies (#534)"

This reverts commit a5c81841ec.
2018-02-04 15:06:21 +01:00
Thomas Leister acaea9251f Enabled bundler multicore support (#529) 2018-02-04 15:01:02 +01:00
Erik Moeller a5c81841ec Add libpam0g-dev to Ubuntu package dependencies (#534)
Required by rpam2
2018-02-04 14:57:44 +01:00
wolfteeth 6a961e899f Clarify Docker instructions for prebuilt images (#533)
* Clarify Docker instructions for prebuilt images

Made clear there are two options for getting the Docker image: pulling the prebuilt image, or building your own. Using a prebuilt image is easier for anyone who hasn't made code changes on their instance.

* Fix errors in Docker prebuilt image instructions
2018-02-04 00:29:50 +01:00
Thomas Leister 8a6a0f899d Update ruby version from 2.4.2 to 2.5.0 (#528) 2018-02-02 11:10:23 +01:00
Mathias B f42e0ce5c8 Add privileges functions (#530)
I add two new commands make_mod and revoke_staff
2018-02-02 11:08:14 +01:00
Eugen Rochko 7f81350fe4
Add 3 steps overview 2018-01-24 02:54:33 +01:00
Norayr Chilingarian f52891ee8e apache config fix. (#520) 2018-01-20 06:23:10 +01:00
David Underwood fc3ebad888 Update Mac install instructions for consistency (#500)
Moves the `libidn` installation command up to the big brew command to keep things consistent.
2017-12-28 14:32:00 -06:00
Cygnan 986660c7c0 Fix variables.scss path (#492)
Signed-off-by: Cygnan <email@cygnan.com>
2017-12-20 22:55:43 +01:00
Drew Crecente 7431659193 Update Administration-guide.md (#491)
Change location of Accounts to Moderation > Accounts
2017-12-18 16:10:32 +01:00
Jim Tittsler 088399a36b Update Docker (#487) 2017-12-17 15:08:48 +01:00
abcang 88d81f14e9 Specify root directive for letsencrypt (#471) 2017-12-06 17:21:08 +01:00
Alda Marteau-Hardi 9474170686 Removes SSL configuration to point users to the Mozilla SSL Configuration Generator 2017-12-05 17:49:30 +01:00
Mike Burns ff454d3215 OpenBSD-specific development guide (#463)
* OpenBSD-specific development guide

The GNU/Linux setup works well but there are some OpenBSD-specific
considerations around default compilers, discovering third-party
libraries, and linker warnings.

* Fix typos
2017-11-27 14:55:59 +01:00
Jim Tittsler b561e44132 Fix typo. (#462) 2017-11-25 18:45:40 +01:00
Sadiq Saif b938713f12 Add remote media attachment cache cleanup section (#452) 2017-11-14 16:02:59 +01:00
Daniel Hunsaker 4c7b2b192a [Nanobox] Update Nanobox Guide
- Be a little clearer about what's going on at each step.
- Give more detailed update instructions (and be smarter about selecting the "latest" tag).
- Mention the `VAPID_*_KEY` variables.
2017-11-12 15:59:03 -07:00
James e8a18d4259 Add email service guide in production-guide.md (#446)
This gives some advice on getting started with an email service guide, including specifics on the process and caveats of the various free services people recommend, as well as a short command in the Rails console that helps a user test this out.
2017-11-10 16:59:21 +01:00
James 0370ea6ec7 Fix typo in Customizing.md (#445)
There was a missing "s" in the directory listing for source.rb
2017-11-10 16:58:06 +01:00
wxcafé 32b98791df
removes mentions of hentai.loan, fixes sentence 2017-10-30 05:44:05 +01:00
nightpool a75e75b63a
Merge pull request #269 from spinda/manage-translations
Add snippet in dev guide about `yarn manage:translations`
2017-10-29 16:19:55 -04:00
Alexander Terczka 0eeb940818 Update Docker-Guide.md
Removed the ssh port forwarding info
2017-10-27 01:54:55 +02:00
Alexander Terczka 3789996bf8 Anonymous git URL is easier for the initial git clone
HTTPS hint added
2017-10-23 14:48:47 +02:00
Nolan Lawson 4f0f399ec0 Add note about #MastoAdmins hashtag (#425) 2017-10-18 16:47:59 +02:00
Nolan Lawson 3a3b8b30bc Add instructions for custom themes (#421)
* Add instructions for custom themes

* Remove notes about custom.scss
2017-10-18 16:32:06 +02:00
Daigo 3 Dango 6a89b3cbe2 Add an explanation how to customize link to source code (#423)
This is to document the merged pull request:
https://github.com/tootsuite/mastodon/pull/4643
2017-10-18 00:25:51 +02:00
Akira 23985a9fb8 add note for commands. (#407)
* add note for commands.

The all listed commands is seemingly bash commands, but the 2nd and latter is command for rails command prompt.

* fix from null to nil
2017-10-13 08:30:32 +02:00
Daggertooth afa7c148f0 Correct 'null' to 'nil' in reactivation section (#422)
Replaced this 'null' with a 'nil' so Ruby won't throw a NameError.
2017-10-13 08:23:54 +02:00
Sadiq Saif 86b4fe9cd5 Rename Security-Guide to Security-Guide.md (#417) 2017-10-09 13:39:44 +02:00
Sadiq Saif 7588d745fb Add Security Guide (#415) 2017-10-08 15:20:56 +02:00
Akira b197f69606 add ExecReload to reload puma. (#406)
* add ExecReload to reload puma.

This enables puma to reload changes without restarting process.

* fix path for command `kill`

* fix to bash.

* change to /bin/kill

* change from hot restart to phased restart.
2017-10-03 16:40:16 +02:00
Yuta Hiroto 80ced41f42 Update ruby version (#404) 2017-09-28 10:46:42 +02:00
Nolan Lawson c4023ea8f5 sw.js should be served with max-age=0 (#355)
This is a new requirement for Mastodon v1.5+; it's mentioned here: https://github.com/tootsuite/mastodon/releases/tag/v1.5.0rc1
2017-09-21 04:21:18 +02:00
Nolan Lawson 1ddceb13de Add migration guide (#396)
* Add migration guide

* Update Migration-guide.md based on PR feedback
2017-09-21 04:13:40 +02:00
Alda Marteau-Hardi d948bdff02 Add instruction to undelete a user. (#374)
* Add instruction to undelete a user.

* Domain is null for local accounts.
2017-09-19 16:35:36 +02:00
Patrick Figel e452628cae Use single quotes for pg user password (#398)
Double quotes are not syntactically correct here.
2017-09-19 16:17:15 +02:00
Jay Logan 3a7c9c3921 Don't include RCs in initial setup (#397)
Fixing the same issue as d9e523ec15 where the command is used in Production-guide.md
2017-09-17 00:19:02 +02:00
Daggertooth d9e523ec15 Don't include RCs when checking out latest tag. (#369)
``git tag -l | sort -V | head -1`` will consider release candidates as the latest version, even if there's a stable release, due to how `sort -V` orders strings. Adding ``grep -v 'rc[0-9]*$'`` to filter out the release candidate tags fixes this.
2017-09-11 02:01:41 +02:00
Eugen Rochko fe6a8ad49d Update Administration-guide.md 2017-09-10 02:46:14 +02:00
Eugen Rochko f29cb7a488 Update Administration-guide.md 2017-09-10 02:31:15 +02:00
Ryanak 22a7c57342 Fix typo (#388) 2017-09-07 19:08:30 +02:00
Sadiq Saif e1c01d42ea Add VAPID keys section to needed variables section (#385)
VAPID keys are necessary for Web Push notifications to work.

Also fix a small typo.
2017-08-26 18:53:14 +02:00
Sadiq Saif fcab2b3c97 "gcc-6" should just be "gcc" (#379)
* "gcc-6" should just be "gcc"

gcc-6 isn't a valid package name

* It was `adduser mastodon` for a reason

making it with `--system and --disabled-password` breaks the rest of the guide where `su - mastodon` is used.

I use this method as it makes maintaining the Mastodon instance easier.

* eval "$(rbenv init -)" should be in ~/.bashrc as well

otherwise the correct ruby version isn't used

* Use sudo su - instead
2017-08-20 22:50:51 +02:00
Mathias B 1e98a53c85 Move curl installation (#380)
Curl need to be installed before the first time we use it. It's now installed before setting up nodejs repository.
2017-08-19 18:58:57 +02:00
Mathias B 8b6eb84430 Reduce Git dependencies (#381)
Here we can use only git-core in place of git.
2017-08-19 18:58:31 +02:00
cybergene 735392fcbd fix typo (#377)
* Add how to create VAPID_PRIVATE_KEY and VAPID_PUBLIC_KEY

* fix typo
2017-08-17 14:47:24 +02:00
Mathias B b69b7fee1a Fix some mistakes (#373)
- Nginx duplication in packages installation
- Specify the user type for `mastodon` (--system and --disabled-password)
- Simplify services start-up
- Clearly write how to check services are running (or not) with `systemctl status`
2017-08-16 22:13:44 +02:00
cybergene 6e52a54bbf Add how to create VAPID_PRIVATE_KEY and VAPID_PUBLIC_KEY (#376) 2017-08-16 22:13:11 +02:00
Sadiq Saif 61e9d31031 Adding my new updating Mastodon guide (#367)
This is guide is for use with my recently merged Production Guide.
2017-08-03 23:51:08 +02:00
Sadiq Saif d8b2b52690 Add libicu-dev to Mastodon apt package list (#366)
libicu-dev was added with v1.5.0, updating guide with this dependency.
2017-08-03 22:45:13 +02:00
Akira fa49976371 Add emoji files for nginx cache rules. (#360)
Some cases such as nginx uses reverse proxy, emoji will return 502 if not set.
+  sort by A-z.
2017-07-30 12:54:26 +02:00
Nolan Lawson b16afa2094 Add libidn11-dev to Ubuntu package dependencies (#356)
This is now required as of Mastodon v1.5.0+ due to idn-ruby.
2017-07-29 14:19:08 +02:00
Sadiq Saif 88b89e61d9 Complete rewrite of Mastodon Production Guide (#352)
* Complete re-write of Mastodon Production Guide

I re-wrote the Mastodon Production Guide so that it has a better structure.

Work on this re-write was done on my own repo:
https://github.com/staticsafe/mastodon-documentation

* Fix typo in a heading

* Change node.js Repository section to use curl|bash method.
For simplicity's sake

* Add an explanation of the dependencies
Added in the "Various Other Dependencies" section.

* Fix links to the Ruby project, was using the link to Rails previously.
2017-07-28 18:18:01 +02:00
Akira dd52795d7d replace g++ for build essential (#354)
g++ doesn't provide necessary package for gem.
2017-07-28 04:37:05 +02:00
Shin Kojima a2352b569f `rbenv install 2.4.1` requires readline-devel (#334)
Tested on Ubuntu Server 16.04.2 LTS

See: https://github.com/rbenv/ruby-build/wiki#trouble-with-irb-or-pry

> * Trouble with irb or pry
>
> Try installing readline and recompiling Ruby.
>
>     Ubuntu: apt-get install libreadline-dev
>     Fedora: yum install readline-devel
2017-07-25 19:16:58 +02:00
Eugen Rochko ab041d036d Fix #325 2017-07-25 19:09:07 +02:00
Eugen Rochko 138a04befd Fix customization docs 2017-07-25 18:09:58 +02:00
Eugen Rochko f8386a5d1e Update list of rake tasks (#347) 2017-07-25 18:04:45 +02:00
Eugen Rochko d8a9f70920 Update Maintenance-Tasks.md 2017-07-25 17:40:04 +02:00
Komic 7ff7949c6c Apache - Updating paths for 1.5.0rc1 (#344) 2017-07-25 00:06:54 +02:00
sdukhovni e65ed605d3 Update index after adding yarn repository (#343) 2017-07-23 11:10:20 +02:00
kfir e0f6fb40b0 Update Development-guide.md (#340)
in order to install ruby-idn we need to make sure we have libidn installed.
2017-07-16 01:40:40 +02:00
Francis 0ffa554fdb Use the Yarn APT/YUM repository instead of npm (#337)
Found this seemed to work better in my experience and also allows for easy updating like any other package.
2017-07-12 02:28:57 +02:00
Sadiq Saif cc3b0e393d Add Let's Encrypt section (#335)
* Add Let's Encrypt section with a short guide to certificate tool installation, certificate generation and automated renewal.

* Use systemctl instead of service in LE section
This is for consistency reasons.
2017-07-11 00:06:03 +02:00
nightpool aa28bbc4b6 remove bit about cronjobs (#333)
this has been out of date for a few months now
2017-07-05 03:01:30 +02:00
のら 36065d56c0 Add list of Rake tasks (#331) 2017-07-04 15:26:54 +02:00
Ash Furrow e976e8c0c7 Adds `mastodon:media:remove_silenced` rake task (#329) 2017-07-02 20:14:40 +02:00
Luclu7 07dd12e873 New server 2017-07-01 05:43:40 +02:00
ik bca4ee4f06 Add the first step to clone. 2017-06-29 20:56:50 +09:00
Luclu7 5cba732c10 Added my instance (#323) 2017-06-27 11:56:37 +02:00
Wexpo Lyu 3d88f71e21 Mention that we can use prebuilt images in docs. (#313)
* Mention that we can use prebuilt images.

Instead of building our own.

* Mention that we need to comment out `build`.

If we want to use prebuilt.
2017-06-27 11:53:59 +02:00
bovarysme e191aaa7a3 Remove the cronjobs section from the production guide 2017-06-25 07:52:20 +02:00
wxcafé 39fe30df48 Update Production-guide.md
Fixes the problem where the `mastodon` user has /bin/false as a shell and so `sudo -iu` won't do anything
2017-06-20 13:39:20 +02:00
Hayato IZUMI 06fc3e68c5 Remove unavailable package from General dependencies for CentOS / RHEL 2017-06-18 13:52:27 +09:00
Charlotte Fields eb317b35bb added some missing info to prod. (#306)
* added some missing info

* changed login and user creation

* corrected user creation and login

hopefully
2017-06-17 15:16:48 +02:00
Charlotte Fields db5c961282 small doc fix (#307) 2017-06-17 14:30:28 +02:00
Aral Balkan 61d6d17904 Update command to checkout latest release.
The git tag command was incorrectly checking out release candidates instead of the latest release. Fixes #309
2017-06-15 17:22:04 +02:00
Benoît S 445dc18cd9 Missing RAILS_ENV=production and bundle exec
If you're omitting RAILS_ENV and `bundle exec` you'll have:

~~~
rake aborted!                             
NameError: uninitialized constant Annotate
[…]
~~~
2017-06-14 17:40:01 +02:00
Raphael Lullis 491e44c346 Create Serving_a_different_domain.md
The location directive was missing the "=" operator.
2017-06-11 03:55:38 +02:00
Valentin Lorentz e2fcb2f407 Update resources of oc.todon.fr 2017-06-04 17:24:38 +02:00
zunda 58d6dcb46a Remove the procedure to run `rake secret` outside the container
This change will help users avoid unnecessary procedure to
complete `bundle install` outside the container.

The explanation

> To generate the PAPERCLIP_SECRET, SECRET_KEY_BASE, and
> OTP_SECRET, you may use:
>
> ```
> rake secret
> ```

gives users a false impression that secrets have to be filled in
before the image can be built. Here, with introduction of CLD3,
completion of `bundle install` became more involved procedure to
prepare tools and libraries as well as higher version of Ruby.
2017-06-02 21:19:30 -10:00
USAMI Kenta e8bcf6a035 Explicitly use --provider option for vagrant up
When a provider other than virtualbox is registered in Vagrant, `vagrant up` can not start Mastodon.
For example, it corresponds to the environment where Parallels Desktop is installed.
2017-05-31 12:52:03 +09:00
koug44 473152c792 Update on apache configuration
Added the needed ProxyPass exceptions for 1.4.1
2017-05-29 17:32:17 -04:00
Myles Braithwaite 2da7d4fc0a Needed pkg-config to install cld3.
In Debian the package `pkg-config` is required to install the rubygem `cld3`.
2017-05-29 14:36:32 -04:00