View source for RefractSurvey Getting Started

This page walks through installing RefractSurvey by hand on a server you've already got. If you're starting from a completely bare Linux box and want the setup automated for you, see [[RefractSurvey_Automated_Server_Setup|Automated Server Setup]] instead &mdash; it does everything below for you plus the server-level setup.

== What you'll need ==

* A web server running '''Apache''' with <code>mod_rewrite</code> available (clean URLs are optional but recommended)
* '''PHP 8.1 or newer''', with the <code>pdo_mysql</code>, <code>mbstring</code>, <code>json</code>, <code>session</code>, and <code>zip</code> extensions enabled
* '''MySQL 5.7+ or MariaDB 10.3+'''

Most standard shared or VPS hosting already has all of this. The install wizard checks every one of these requirements for you and won't let you continue until they're met, so there's no need to double-check by hand beforehand.

== Installing ==

# Copy the <code>refractsurvey/</code> folder to your web server, so its contents are what a visitor to your domain actually reaches.
# Make sure the <code>config/</code> folder is writable by the web server's user &mdash; the installer needs to write your database credentials there.
# Visit <code>install.php</code> in your browser and follow the wizard. It walks through:
#* '''Requirements''' &mdash; a live checklist of the PHP/Apache requirements above, with a re-check button if you need to fix something and try again.
#* '''Database''' &mdash; where your MySQL/MariaDB server is and which database to use.
#* '''Database user''' &mdash; the wizard creates a new, scoped database account for the app to use day-to-day, rather than reusing your admin database credentials.
#* '''Appearance''' &mdash; pick a starting color theme (you can change this, and pick from the full set of 15, any time afterward from Manage &gt; Application Config).
#* '''Your account''' &mdash; create the first admin login and your first project.
# That's it &mdash; you'll land on the login page ready to sign in.

<code>install.php</code> refuses to run a second time once <code>config/config.php</code> exists, so there's no need to delete it afterward for safety's sake. If you ever do want to re-run the wizard from scratch, deleting <code>config/config.php</code> on the server is the supported way to do that.

== Everyday use ==

* Staff sign in at <code>/login</code>. Everything else in the navigation (Surveys, Manage) requires being logged in and having the relevant permission &mdash; see [[RefractSurvey_Permissions_and_Roles|Permissions and Roles]].
* The site's root URL (<code>/</code>) is always the '''public''' survey landing page &mdash; it asks an anonymous visitor for their access code and nothing else. That's the link you hand out to testers.
* Build a survey under a project, add groups and questions, then publish it. Generate access codes from the survey's Codes page and hand them out &mdash; see [[RefractSurvey_Codes|Codes]].
* Save any survey's current questions as a template from its builder page, then start a new survey from that template later &mdash; see [[RefractSurvey_Templates|Templates]].

== Next steps ==

* [[RefractSurvey_Projects|Projects]] &mdash; set up your first project
* [[RefractSurvey_Upgrading|Upgrading]] &mdash; what to do when a new version comes out
* [[RefractSurvey_Security_Notes|Security Notes]] &mdash; what RefractSurvey already does to keep things locked down

[[Category:RefractSurvey]]