325 Commits

Author SHA1 Message Date
Ben Sturmfels
9650aa394b Spell-check the entire documentation. 2016-09-18 16:28:22 +03:00
Loic Dachary
d5421cc366 Fix #822 - doc typo s/Plugin/PluginManager/
Signed-off-by: Loic Dachary <loic@dachary.org>
2016-07-25 03:45:35 +03:00
Christopher Allan Webber
1f23be2d85 A bit of a documentation update around celery systemd init files 2016-07-13 09:11:40 -05:00
Christopher Allan Webber
6686502f17 doc: 0.9.0 release notes
* doc/source/siteadmin/relnotes.rst: Add release notes for 0.9.0.
2016-03-29 11:30:26 -07:00
Christopher Allan Webber
dcccf654f5 doc: Update developer migration docs for Alembic as primary migration system
* docs/source/devel/migrations.rst: Update to reflect sqlalchemy-migrate
  as being deprecated and Alembic as being the new way of doing
  migrations.
2016-03-26 11:39:08 -07:00
Christopher Allan Webber
cca25b6fcf doc: Update plugins documentation in light of alembic branching usage
* docs/source/siteadmin/plugins.rst:
  Added a reminder to run "./bin/gmg dbupdate" after installing a plugin.
  Added a new "Deactivating plugins" section.
  Renamed "Removing plugins" to "Removing plugin packages".
2016-03-26 11:39:08 -07:00
Christopher Allan Webber
5409a6cf23 doc: Note that plugin authors must NEVER modify tables they don't control
* docs/source/pluginwriter/database.rst: New paragraph.
2016-03-26 11:39:08 -07:00
Christopher Allan Webber
ee843c4783 Update database docs for plugin authors for new alembic branching world
Things have gotten both easier and more complex in the branching world
view.  Plugins branch off of main with their own migrations.
Generating these has become a bit easier, but the steps for doing this
are a bit wordy to explain.

* docs/source/pluginwriter/database.rst: Update both the
  "Creating new Tables" and "Changing the Database Schema Later"
  sections accordingly.
2016-03-26 11:39:08 -07:00
Christopher Allan Webber
e2212f944b Basic explaination of how to deploy with Python 3.
Could be better, but "works" for now.
2016-02-20 12:47:59 -08:00
Christopher Allan Webber
c9cdb03657 Move Ubuntu -> *buntu because of absurd trademark issues
For more context, see:
  http://joeyh.name/blog/entry/trademark_nonsense/
2016-02-19 11:51:20 -08:00
Loic Dachary
63b5959fd4 Fix #947 - media_type configuration files location
Document the location of the config_spec.ini files for media_types.

Signed-off-by: Loic Dachary <loic@dachary.org>
2016-01-22 11:10:45 -08:00
Loic Dachary
6ec0393df0 Fix #5359 - unpriviledged -> unprivileged 2016-01-19 15:19:08 -08:00
Boris Bobrov
63053f8c66 Merge branch 'stable' 2015-12-21 02:46:24 +03:00
Christopher Allan Webber
ca3dd10e2b Fixing typo (thanks breton) 2015-12-20 10:58:43 -06:00
Christopher Allan Webber
9b9c04e6ac 0.8.1 release notes 2015-12-20 09:53:25 -06:00
Christopher Allan Webber
13f187992a Kludgey documentation fix so that python 2 does not break with flup
See also Issue #5373
2015-12-14 14:19:20 -06:00
Christopher Allan Webber
3169dde0c4 Note that users have to install node.js :\ 2015-06-03 22:15:11 -05:00
Christopher Allan Webber
f5ac2b61f7 Better phrasing: "Should I Keep Open Registration Enabled?" 2015-05-30 10:34:10 -05:00
Christopher Allan Webber
3f088a3f3d "Should I enable registration?" section 2015-05-30 10:27:54 -05:00
Jim Campbell
b791ae973c docs: Added handling of user_dev permissions
The user_dev directory gets created when users get established
and they start uploading media. However, the permissions aren't
correct on the directory as it gets created.

As a workaround, we create the directory at this stage, and then
set the proper permissions.

See this mailing list post for more information:
http://lists.mediagoblin.org/pipermail/devel/2015-May/001201.html
2015-05-26 00:44:10 -05:00
Christopher Allan Webber
c2382bd4ea Clarifying the "note these steps" 2015-05-22 11:28:23 -05:00
Christopher Allan Webber
6adee95a25 No need to run git submodule init/update, run by bootstrap.sh 2015-05-22 11:15:00 -05:00
Christopher Allan Webber
11199c3161 Switch git remote url 2015-05-22 11:11:42 -05:00
Christopher Allan Webber
4baccdf89e Wrong version number. Stupid copy-pasta! 2015-05-22 11:08:45 -05:00
Christopher Allan Webber
a87db7f547 0.8.0 release notes
Theoretically correct... I need to verify that the steps work as
expected
2015-05-22 10:53:43 -05:00
Jim Campbell
52628d64a4 docs: Set paster service to start before celery
For some reason, celery wouldn't start if I started it first.
Setting paster to start first. Celery starts just fine on initial run
after paster is running.
2015-05-19 01:54:50 -05:00
Jim Campbell
4c89287c3d docs: Updated permissions. Tweaked install details
Added nginx to installation packages. We say that our install uses
nginx, so users should skip nginx if they want to use apache. Also,
our group permissions depend on a web server being installed.

Changed install directory for mediagoblin acct to /var/lib/mediagoblin
It works better if we need to back up data.

Assigned mediagoblin user to the same group as the web server. This
is needed so that the server can access uploaded media.

Created mediagoblin group for non-web-server things such as logs.
2015-05-19 01:50:07 -05:00
Jim Campbell
80fe8e4c39 docs: Removed systemcl enable/start. Already issued.
Debian-based platforms start the postgres server by default after
installation. For RPM-based distros, we've already issued these
commands prior to configuring the postgres server.
2015-05-18 21:19:42 -05:00
Jim Campbell
a03920751f docs: Need to start postgres on rpm distros
Need to enable / start postgres database on rpm-based distros
before you create the postgres mediagoblin user and database.
If you don't start the database server, you can't create a
database user or database.
2015-05-18 21:12:37 -05:00
Jim Campbell
041c93634b docs: Formatting tweaks to production-deployments.rst
Corrected typos and fixed rst formatting issues.
2015-05-15 18:38:31 -05:00
Jim Campbell
7d74b404ac docs: Added systemd info. Reworked init script info.
Added tested systemd service files. Modified the structure of the
section about init scripts.
2015-05-11 22:38:06 -05:00
Jim Campbell
cd7af7899f docs: Clean up nginx instructions
Made it more clear what commands to use if you're on deb/rpm-based system.

Added a note that shows the user how to test their nginx configuration.
2015-05-11 21:16:30 -05:00
Jim Campbell
3948e44c9a docs: Added 'sudo' to cmd. Made 'exit' from postgres acct more clear.
Added a missing reference to 'sudo' in a command. Made the exit from
the postgres account more clear to reduce the chance for user error.
2015-05-11 20:41:01 -05:00
Jim Campbell
7bba6d2e9c docs: Removed chkconfig cmd. Made 'exit' more explicit.
The chkconfig command is only needed on CentOS 6, which isn't really
a supported multimedia platform. CentOS 7 and Fedora 21+
wouldn't require this command.

Also made the "exit" command (used after setting up the postgres
mediagoblin account and database) more explicit. This will help prevent
user errors for users who may skim through the documentation.
2015-05-11 20:15:08 -05:00
Jim Campbell
ec255f63be docs: Copy paste.ini to paste_local.ini
Some scripts on the internet have referenced paste_local.ini, so
it is safer to have a copy on the filesystem by default, even if
the user doesn't need to change any of the values for a regular
setup.
2015-05-11 19:00:40 -05:00
Jim Campbell
94a5d6a81d docs: Typo fix. Fixed repated reference to gstreamer1.0-libav 2015-05-11 19:00:40 -05:00
Jim Campbell
8af91ceae7 docs: Updated gstreamer audio media type requirements to gst-1.0
Previous media type docs referenced gstreamer0.10, but we've updated
to gstreamer1.0.

Also, Debian ships libav instead of ffmpeg now. Updated docs
accordingly

Finally, simplified the install instructions to two commands instead
of four commands.
2015-05-11 19:00:40 -05:00
Christopher Allan Webber
8d59cd1f98 Note on what --without-virtualenv does 2015-04-28 14:14:44 -05:00
Jim Campbell
ef2642f7bb docs: Require nodejs-legacy on Debian-based systems. Remove un-needed text.
Per this announcement [0], Debian is using 'nodejs-legacy' as a
compatability package for what they used to call 'node'.
- Fixes bug 5080 [1].

Remove note about warning that users would no longer see.

[0] https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=614907#108
[1] https://issues.mediagoblin.org/ticket/5080
2015-04-19 12:39:05 -05:00
Jim Campbell
44db13fa84 docs: Updated deployment docs to use sudo. Other various fixes.
- Use sudo instead of root user but give info on how to configure sudo.
- Changed docs to reference Jessie as the stable version of Debian
- Corrected the command to create the 'mediagoblin' system account
  - Fixes https://issues.mediagoblin.org/ticket/5083
2015-04-19 12:01:10 -05:00
Christopher Allan Webber
a35b7c7fb3 Merge branch 'stable'
Conflicts:
	docs/source/siteadmin/deploying.rst
	docs/source/siteadmin/relnotes.rst
2015-04-17 17:09:06 -05:00
Christopher Allan Webber
9fa1e602b4 Noting the possibility that users may need to update origin to Savannah 2015-04-17 17:00:54 -05:00
Boris Bobrov
4fd98b70d2 change git address to savannah's git 2015-04-17 16:56:18 -05:00
Christopher Allan Webber
3ae2371242 Don't forget to stop the processes, too! 2015-04-17 16:31:56 -05:00
Christopher Allan Webber
50c6dc2bf1 Always be backing up 2015-04-17 16:31:56 -05:00
Boris Bobrov
f6d1b29f82 fix incorrect syntax in docs (bug 5310) 2015-04-11 01:02:08 +03:00
Jim Campbell
9a1ba0e87f docs: Removed note about installing from master. Clarified root/nonroot usage.
There was a note informing the user that they should be aware that we
encourage them to install from the *master* branch, but we no longer
do that. If they follow our deployment docs, they will pull in &
use the *stable* branch.

Also clarified some root / non-root system usage by either specifying
a leading *hash* symbol to indicate a root-based command, or a
dollar sign to indicate a non-root command.
2015-03-30 23:47:49 -05:00
Jim Campbell
c3075e9178 docs: Updated instructions re: Postgresql setup
Added information about needed packages for RPM-based systems,
and simplified instructions to rely on the root account rather than
sudo-based instructions.

If a user has sudo access, they can easily add "sudo" to the needed
commands.

Also added information about enabling postgres to start on boot
and how to start it for the current session.
2015-03-30 23:40:01 -05:00
Jim Campbell
ecf5a532f4 docs: Fixed typo - missing closing bracket in link in api.rst 2015-03-29 20:10:39 -05:00
Jim Campbell
6663dfa38c docs: Switched to 'useradd', as it is a more cross-distro cmd.
'adduser' is installed on Debian-based systems by default, but is
not installed by default on Fedora-based systems. 'useradd' is
installed by default on Debian-based systems, as well. The
'useradd'-based command provides the same functionality as
'adduser' in this case, though setting up a 'system' user with
no password.

Per bug 886, I've added the '--user-group' flag, which creates a
mediagoblin group, and assigns the mediagoblin user to this
group, too.
2015-03-29 19:40:36 -05:00