Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@djmattyg007
djmattyg007 committed Jul 5, 2017
1 parent 155223d commit 10f71eb
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions INSTALL.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ Installation Guide

6. Create a User account to access the web interface by running the following
command:
php entry/user.php create name username password
php cli/user.php create name username password
For more information about managing Users, look at user_management.txt in
the documentation. For more broad information on access control, look at
accesscontrol_overview.txt.

7. Add your first Path! Albums are represented as Paths in Pictorials:
php entry/path.php create name fullpath
php cli/path.php create name fullpath
For more information about managing Paths, look at path_management.txt in
the documentation. For general information about Paths, look at
paths_overview.txt.

8. Give your User account access to your first Path:
php entry/path.php allow --user --add path_id username
php cli/path.php allow --user --add path_id username

9. If you told the installer to automatically create the webroot files for you,
you're done! If not, now is when you need to create those files. First,
Expand All @@ -61,7 +61,7 @@ Installation Guide

That's it! You should now have a fully functioning image gallery. Point your
web browser to the PHP file specified for the --script-baseurl flag, login with
the User account you created in Step 6, and browse one of the paths you
the User account you created in Step 6, and browse to one of the paths you
configured in Step 7.

Remember that you can view a live demo at https://pictorials-demo.matthewgamble.net
10 changes: 5 additions & 5 deletions docs/group_management.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,33 @@ commands available for administrators. All examples assume your current working
directory is the base Pictorials path.

Create
Run: php entry/group.php create [name]
Run: php cli/group.php create [name]

Use this to create a new group. If you omit the name, you will be greeted with
an interactive prompt to enter the name.

Delete
Run: php entry/group.php delete [name]
Run: php cli/group.php delete [name]

Use this to delete an existing group. If you omit the name, you will be greeted
with an interactive prompt to enter the name.

View
Run: php entry/group.php view [name]
Run: php cli/group.php view [name]

Displays the name of the Group and any Users that are a member of the Group. If
you omit the name, you will be greeted with an interactive prompt to enter the
name.

Add User
Run: php entry/group.php adduser [name [username]]
Run: php cli/group.php adduser [name [username]]

Use this to add a User to a Group. The two arguments must be passed in order.
If you omit any of the arguments, you will be greeted with an interactive
prompt to enter the remaining details.

Remove User
Run: php entry/group.php removeuser [name [username]]
Run: php cli/group.php removeuser [name [username]]

Use this to remove a User from a Group. The two arguments must be passed in
order. If you omit any of the arguments, you will be greeted with an
Expand Down
16 changes: 8 additions & 8 deletions docs/path_management.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ commands available for administrators. All examples assume your current working
directory is the base Pictorials path.

Create
Run: php entry/path.php create [--sortorder=<number>] [name [path]]
Run: php cli/path.php create [--sortorder=<number>] [name [path]]

The two non-optional arguments must be passed in order. If you omit one or more
of them, you will be greeted with an interactive prompt to enter the remaining
Expand All @@ -14,40 +14,40 @@ zero. The sort order affects the order of albums presented to the end user in
the web interface.

Delete
Run: php entry/path.php delete path_id
Run: php cli/path.php delete path_id

Use this to delete a single path.

List
Run: php entry/path.php list [--sort[=(sortorder|name)]]
Run: php cli/path.php list [--sort[=(sortorder|name)]]

Displays the full list of Paths in the system, optionally sorted. Pass
--sort=sortorder to sort the list by the sort order values specified in the
database. Pass --sort=name to sort by path names. Passing --sort with no value
defaults to sorting by the sort order values specified in the database.

Update
Run: php entry/path.php update path_id [--name=<name>] [--path=<path>] [--sortorder=<number>]
Run: php cli/path.php update path_id [--name=<name>] [--path=<path>] [--sortorder=<number>]

Updates various details about a given path. At least one of --name, --path or
--sortorder must be specified.

View
Run: php entry/path.php view path_id
Run: php cli/path.php view path_id

For the given Path, this command displays the name, full path, sort order,
permissions, which Users and Groups have access and which Users and Groups are
denied access.

Permission
Run: php entry/path.php permission (--add|--remove) path_id permission
Run: php cli/path.php permission (--add|--remove) path_id permission

This command is used to assign or remove permissions (eg. 'gps', 'symlinks',
etc) from a particular Path. See permissions.txt for a detailed overview of all
available permissions.

Allow
Run: php entry/path.php allow (--add|--remove) (--user|--group) path_id [entity_name]
Run: php cli/path.php allow (--add|--remove) (--user|--group) path_id [entity_name]

This command is used to allow a User or Group access to view a particular Path.
You must specify whether you are adding or removing the access with --add or
Expand All @@ -57,7 +57,7 @@ the entity. If you omit the name of the entity, you will be greeted with an
interactive prompt to enter the name.

Deny
Run: php entry/path.php deny (--add|--remove) (--user|--group) path_id [entity_name]
Run: php cli/path.php deny (--add|--remove) (--user|--group) path_id [entity_name]

This command is used to deny a User or Group access to view a particular Path.
You must specify whether you are adding or removing the denial with --add or
Expand Down
10 changes: 5 additions & 5 deletions docs/user_management.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,33 @@ various commands available for administrators. All examples assume your current
working directory is the base Pictorials path.

Create
Run: php entry/user.php create [name [username [password]]]
Run: php cli/user.php create [name [username [password]]]

The three arguments must be passed in order. If you omit one or more of them,
you will be greeted with an interactive prompt to enter the remaining details.

Delete
Run: php entry/user.php delete [username]
Run: php cli/user.php delete [username]

Use this to delete a single user. If you omit the username, you will be greeted
with an interactive prompt to enter the username.

View
Run: php entry/user.php view [username]
Run: php cli/user.php view [username]

This presents you with the User's name, and a list of any Groups they are a
member of. If you omit the username, you will be greeted with an interactive
prompt to enter the username.

List
Run: php entry/user.php list [--sort[=(username|name)]]
Run: php cli/user.php list [--sort[=(username|name)]]

Displays the full list of Users in the system, optionally sorted. Pass
--sort=username to sort the list by username. Pass --sort=name to sort by
names. Passing --sort with no value defaults to sorting by username.

Update
Run: php entry/user.php update [username [name]]
Run: php cli/user.php update [username [name]]

Use this to update a user's name. If you omit any of the arguments, you will be
greeted with an interactive prompt to enter the remaining details.

0 comments on commit 10f71eb

Please sign in to comment.