[mediagoblin.git] / mediagoblin / plugins / archivalook / README.txt


.&&&&&&&&&&&&&&&&&&&&&&&&&&&&.
!&& A R C H I V A L O O K &&&!
,============================,
``````````````````````````````

Q: What is this?
A: It's a very simple plugin for MediaGoblin <http://mediagoblin.org>

Q: What does it do?
A: Archivalook swaps the default MediaGoblin front page (which is a gallery of
the most recent media submitted) with a new front page that is better for cura-
ted websites. Instead of showing the most recent media, archivalook shows
Featured Media on the front page.

Q: How do I install it?
A: Check out this page for instructions:
http://mediagoblin.readthedocs.org/en/v0.6.1/siteadmin/plugins.html
Be sure to run ./bin/gmg assetlink after you have added the plugin to your
instance, this is necessary because the plugin uses custom css.

Q: I set it up but I still can't feature media, what do I do?
A: So when you first activate this plugin, no users have the proper user
permissions to manage featured media. Below this I'll give instructions of how
to give those permissions to yourself and no one else:

    1) If you haven't already, create a user for yourself. You can do this
       one of two ways
        a) you can run your website, visit it, click the link that says `Login`
           (in the top right corner), and then click the link that says
           `Register`. Enter your information and you now have a user account.
        b) you can use the command line tool. in a terminal, navigate to your
           mediagoblin directory. run the command
               $ ./bin/gmg adduser
           and then follow the prompts on screen.
    2) Next, you need to use the command line tool to make yourself an admin.
       If you haven't already, navigate to the mediagoblin directory in a
       terminal. Once there, run the command
               $ ./bin/gmg makeadmin <username>
       where instead of <username> you type in your actual username :P
    3) Now you're the admin! Next, you need to run your server. It's fine if
       you run it locally, by just running:
               $ ./lazyserver.sh
       from the mediagoblin directory. Visit the website, and if you click the
       downard facing arrow to the top left, you should see that you now have
       access to new pages, the very useful moderation panels. Click on the one
       labeled `User Moderation Panel`.
    4) You should be directed to a (possibly very short) table of users, find
       your own username, and click on it.
    5) Now you see your own `User's Detail Page`. At the bottom you should see
       a table of all the things your user has permission to do, including
       being active, and being an administrator. You should see that you don't
       have permission to feature media. Fix that by clicking the `+` button to
       the right of 'Featurer'.
    6) Wooo! Now you can feature and unfeature media!
Commit	Line	Data
f3ced5db	1
	2	.&&&&&&&&&&&&&&&&&&&&&&&&&&&&.
	3	!&& A R C H I V A L O O K &&&!
	4	,============================,
	5	``````````````````````````````
	6
	7	Q: What is this?
	8	A: It's a very simple plugin for MediaGoblin <http://mediagoblin.org>
	9
	10	Q: What does it do?
	11	A: Archivalook swaps the default MediaGoblin front page (which is a gallery of
	12	the most recent media submitted) with a new front page that is better for cura-
	13	ted websites. Instead of showing the most recent media, archivalook shows
	14	Featured Media on the front page.
	15
	16	Q: How do I install it?
	17	A: Check out this page for instructions:
	18	http://mediagoblin.readthedocs.org/en/v0.6.1/siteadmin/plugins.html
2e76016c	19	Be sure to run ./bin/gmg assetlink after you have added the plugin to your
2e76016c	20	instance, this is necessary because the plugin uses custom css.
f3ced5db	21
	22	Q: I set it up but I still can't feature media, what do I do?
	23	A: So when you first activate this plugin, no users have the proper user
	24	permissions to manage featured media. Below this I'll give instructions of how
	25	to give those permissions to yourself and no one else:
	26
	27	1) If you haven't already, create a user for yourself. You can do this
	28	one of two ways
	29	a) you can run your website, visit it, click the link that says `Login`
	30	(in the top right corner), and then click the link that says
	31	`Register`. Enter your information and you now have a user account.
	32	b) you can use the command line tool. in a terminal, navigate to your
	33	mediagoblin directory. run the command
	34	$ ./bin/gmg adduser
	35	and then follow the prompts on screen.
	36	2) Next, you need to use the command line tool to make yourself an admin.
	37	If you haven't already, navigate to the mediagoblin directory in a
	38	terminal. Once there, run the command
	39	$ ./bin/gmg makeadmin <username>
	40	where instead of <username> you type in your actual username :P
	41	3) Now you're the admin! Next, you need to run your server. It's fine if
	42	you run it locally, by just running:
	43	$ ./lazyserver.sh
	44	from the mediagoblin directory. Visit the website, and if you click the
	45	downard facing arrow to the top left, you should see that you now have
	46	access to new pages, the very useful moderation panels. Click on the one
	47	labeled `User Moderation Panel`.
	48	4) You should be directed to a (possibly very short) table of users, find
	49	your own username, and click on it.
	50	5) Now you see your own `User's Detail Page`. At the bottom you should see
	51	a table of all the things your user has permission to do, including
	52	being active, and being an administrator. You should see that you don't
	53	have permission to feature media. Fix that by clicking the `+` button to
	54	the right of 'Featurer'.
	55	6) Wooo! Now you can feature and unfeature media!