Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add more details for user management #490

Merged
merged 1 commit into from
Oct 26, 2023
Merged

docs: add more details for user management #490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,31 @@ curl http://127.0.0.1:8088/api/v3/version

On startup, some GRASS GIS locations are created by default but they are still empty. How to get some geodata to start processing, see in [Testing GRASS GIS inside a container](#grass-gis) below.

## Adding a user

Adding the standard demouser:

```
actinia-user create -u demouser -g user -w "gu3st!pa55w0rd" -r user
```

Show what the demouser is allowed to do:

```
curl http://127.0.0.1:8088/api/v3/users/demouser
```

Enable new command for demouser: You first need to enter the running docker image, then `update_add` the command:

```
docker ps

# use ID of running actinia docker image (example)
docker exec -it 9cf4b370b220 sh

actinia-user update_add -u demouser -m r.import
```

<a id="latest-grass-gis"></a>

## Installation with most recent GRASS GIS version
Expand Down Expand Up @@ -85,8 +110,13 @@ python3 setup.py install
sh /src/start.sh
```

Now you have a running actinia instance locally.
For debugging or if you need to start the wsgi server regularly during development, you don't need to repeat all steps from inside the start.sh file. Instead, run the server with only one worker:
Now you have a running actinia instance locally! Check with

```
curl http://127.0.0.1:8088/api/v3/version
```

For debugging or if you need to start the wsgi server regularly during development, you don't need to repeat all steps from inside the `start.sh` file. Instead, run the server with only one worker:

```
python3 setup.py install
Expand Down Expand Up @@ -156,6 +186,8 @@ grass /actinia_core/grassdb/nc_spm_08/PERMANENT --exec v.random output=myrandom
grass /actinia_core/grassdb/nc_spm_08/PERMANENT --exec v.info -g myrandom
```

# Testing GRASS GIS through actinia's REST API

You now have some data which you can access through actinia. To get information
via API, start actinia with gunicorn and run

Expand Down
8 changes: 8 additions & 0 deletions docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Actinia - The GRASS GIS REST API

<!-- **** Begin Fork-Me-On-Gitlab-Ribbon-HTML. See MIT License at https://gitlab.com/seanwasere/fork-me-on-gitlab **** -->
<a href="https://github.com/actinia-org/actinia-core/tree/main/docs/docs">
<span id="fork-me" style="font-family: tahoma; font-size: 18px; position:fixed; top:50px; right:-45px; display:block; -webkit-transform: rotate(45deg); -moz-transform: rotate(45deg); color:white; padding: 4px 30px 4px 30px; z-index:99; opacity:0.6">Fork Me On GitHub</span>
</a>
<!-- **** End Fork-Me-On-Gitlab-Ribbon-HTML **** -->

<!-- URL of this document: [https://actinia-org.github.io/actinia-core](https://actinia-org.github.io/actinia-core) -->

**Actinia** is an open source REST API for scalable, distributed, high
performance processing of geographical data that uses GRASS GIS for
computational tasks.
Expand Down