Getting started - Revision history

Sallain at 22:51, 11 February 2020

2020-02-11T22:51:31Z

Ablewer: /* Projects */

2019-12-11T20:25:26Z

Projects

Artefactual at 18:44, 10 August 2018

2018-08-10T18:44:18Z

Sevein: /* Installation */

2018-06-27T21:09:21Z

Installation

Sevein: /* Local install (Legacy) */

2017-08-03T21:00:20Z

Local install (Legacy)

Hbecker: Add links to dev docs, add to dev docs category

2017-03-15T23:08:11Z

Add links to dev docs, add to dev docs category

Hbecker: /* How do I activate the Storage Service virtualenv? */ Mention fish problems

2016-08-26T18:43:52Z

How do I activate the Storage Service virtualenv?: Mention fish problems

Hbecker: /* Tests */ Mention virtualenv for SS tests

2016-08-26T18:34:03Z

Tests: Mention virtualenv for SS tests

Hbecker: /* FAQ */ Use headers instead of a list

2016-08-26T18:30:14Z

FAQ: Use headers instead of a list

Hbecker: /* FAQ */ activate SS virtualenv

2016-08-10T17:23:15Z

FAQ: activate SS virtualenv

← Older revision		Revision as of 22:51, 11 February 2020
Line 1:		Line 1:
	[[Main Page]] > [[Development]] > [[:Category:Development documentation\|Development documentation]] > Getting Started		[[Main Page]] > [[Development]] > [[:Category:Development documentation\|Development documentation]] > Getting Started
		+
		+	<div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/docs/latest/ Archivematica documentation] for up-to-date information.</div><p>

	This wiki page describes getting started with Archivematica as a developer. For user and administrative manuals, please see http://www.archivematica.org.		This wiki page describes getting started with Archivematica as a developer. For user and administrative manuals, please see http://www.archivematica.org.

@@ Line 18: / Line 18: @@
 * [https://github.com/artefactual/archivematica Archivematica]: Main repository containing the user-facing dashboard, task manager MCPServer and clients scripts for the MCPClient
 * [https://github.com/artefactual/archivematica-storage-service Storage Service]: Responsible for moving files to Archivematica for processing, and from Archivematica into storage
 There are also several smaller repositories that support Archivematica in various ways.  In general, you will not need these to develop on Archivematica.

@@ Line 63: / Line 63: @@
 # You can now access the following services in a web browser:
 #* Archivematica - http://192.168.168.192
-#* Archivematica Storage Service: http://192.168.168.192:8000 (user: test, pass: test)
+#* Archivematica Storage Service: http://192.168.168.192:8000
 You may also wish to do the following.

@@ Line 38: / Line 38: @@
 == Installation ==
 The recommended way to install Archivematica for development is with Ansible and Vagrant.
 === Ansible & Vagrant ===

@@ Line 74: / Line 74: @@
 #* For more variables to control deployment, see the [https://github.com/artefactual-labs/ansible-role-archivematica-src/blob/master/README.md  README]
 # See also the FAQ below
 === Alternative Vagrant projects ===

@@ Line 1: / Line 1: @@
-[[Main Page]] > [[Development]] > Getting Started
+[[Main Page]] > [[Development]] > [[:Category:Development documentation|Development documentation]] > Getting Started
 This wiki page describes getting started with Archivematica as a developer. For user and administrative manuals, please see http://www.archivematica.org.
@@ Line 205: / Line 205: @@
 You will also want to set environment variables as described in the storage service testing section.

← Older revision		Revision as of 18:43, 26 August 2016
Line 202:		Line 202:
	<code>source /usr/share/python/archivematica-storage-service/bin/activate</code>		<code>source /usr/share/python/archivematica-storage-service/bin/activate</code>

−	The location of the virtualenv is configured as part of the ansible install~~. By~~ default~~, the virtualenv~~ is at <code>/usr/share/python/archivematica-storage-service</code> Sourcing the activate script should modify the prompt to display <code>(archivematica-storage-service)vagrant@am-local</code>. You will ~~probably~~ also want to set environment variables, as described in the storage service testing section.	+	The location of the virtualenv is configured as part of the ansible install, which by default is <code>/usr/share/python/archivematica-storage-service</code> Sourcing the activate script should modify the prompt to display <code>(archivematica-storage-service)vagrant@am-local</code>. Note that if you're running fish, the activate script will not work; you may want to look in to [http://virtualfish.readthedocs.io/en/latest/ virtualfish].
		+
		+	You will also want to set environment variables as described in the storage service testing section.

@@ Line 96: / Line 96: @@
 === Archivematica ===
-Before running Archivematica tests, set the following environment variable.
+Before running Archivematica tests, set the following environment variable.  Archivematica does not currently have a virtualenv that needs to be activated.
 <pre>
@@ Line 110: / Line 110: @@
 === Storage Service ===
-Before running Storage Service tests, set the following environment variables
+Before running Storage Service tests, activate the virtualenv and set the following environment variables. The tests should be run from the <code>storage_service</code> directory.  This is the same directory that contains <code>manage.py</code>. You may need to install <code>requirements/test.txt</code> to install testing dependencies.
 <pre>
@@ Line 124: / Line 124: @@
 export DJANGO_SECRET_KEY='ADDKEY'
 </pre>
 == FAQ ==

@@ Line 129: / Line 129: @@
 == FAQ ==
-* How do I restart everything in Archivematica?
+=== How do I restart everything in Archivematica? ===
 A default install using Ansible also installs the devtools.  Run <code>am restart-services</code> to restart all services related to Archivematica and the storage service.
-* How do I restart just the dashboard?
+=== How do I restart just the dashboard? ===
 <code>sudo /etc/init.d/apache2 start</code> or <code>sudo service apache2 restart</code>
-* How do I restart the storage service?
+=== How do I restart the storage service? ===
 <code>sudo service uwsgi restart</code>
-* How do I restart nginx?
+=== How do I restart nginx? ===
 <code>sudo service uwsgi restart</code>
 <code>sudo service nginx restart</code>
-* How do I update or reset an ansible install?
+=== How do I update or reset an ansible install? ===
 To update an install, re-run <code>vagrant provision</code>.  If you only want to run part of the ansible tasks, you can use ansible's tags, for example: <code>env ANSIBLE_ARGS="--tags=amsrc-ss-code" vagrant provision</code>  More tags are documented in the [https://github.com/artefactual-labs/ansible-role-archivematica-src ansible repo]
@@ Line 200: / Line 200: @@
 </pre>
-* How do I activate the Storage Service virtualenv?
+=== How do I activate the Storage Service virtualenv? ===
-This is configured as part of the ansible install.  By default, the virtualenv is at <code>/usr/share/python/archivematica-storage-service</code>
+<code>source /usr/share/python/archivematica-storage-service/bin/activate</code>
-<pre>source /usr/share/python/archivematica-storage-service/bin/activate</pre>
+The location of the virtualenv is configured as part of the ansible install.  By default, the virtualenv is at <code>/usr/share/python/archivematica-storage-service</code>  Sourcing the activate script should modify the prompt to display <code>(archivematica-storage-service)vagrant@am-local</code>.  You will probably also want to set environment variables, as described in the storage service testing section.

← Older revision		Revision as of 17:23, 10 August 2016
Line 199:		Line 199:

	</pre>		</pre>
		+
		+	* How do I activate the Storage Service virtualenv?
		+
		+	This is configured as part of the ansible install. By default, the virtualenv is at <code>/usr/share/python/archivematica-storage-service</code>
		+
		+	<pre>source /usr/share/python/archivematica-storage-service/bin/activate</pre>
		+
		+	This should modify the prompt to display <code>(archivematica-storage-service)vagrant@am-local</code>. You will probably also want to set environment variables, as described in the storage service testing section.