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.

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

Improvement to docs, license update #373

Merged
merged 1 commit into from
Jan 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020-2023 Ryan Lambert
Copyright (c) 2020-2024 Ryan Lambert

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
23 changes: 21 additions & 2 deletions docs/src/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,18 @@ logic, an post-processing steps required. Features include:

This section outlines a typical import using Docker to run PgOSM Flex.

Create directory for the `.osm.pbf` file, output `.sql` file, log output, and
the osm2pgsql command ran.
### Prepare

Create directory for the `.osm.pbf` file and output `.sql` file. These files
are automatically created by PgOSM Flex.


```bash
mkdir ~/pgosm-data
```

### Run

Set environment variables for the temporary Postgres connection in Docker.
These are required for the Docker container to run.

Expand All @@ -77,6 +81,21 @@ docker run --name pgosm -d --rm \
-p 5433:5432 -d rustprooflabs/pgosm-flex
```

### Check Docker container running

It is worth verifying the Docker container is successfully running with `docker ps -a`.
Check for a `STATUS` similar to `Up 4 seconds` shown in the example output below.

```bash
$ docker ps -a

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
e7f80926a823 rustprooflabs/pgosm-flex "docker-entrypoint.s…" 5 seconds ago Up 4 seconds 0.0.0.0:5433->5432/tcp, :::5433->5432/tcp pgosm
```


### Execute PgOSM Flex

Use `docker exec` to run the processing for the Washington D.C subregion.
This example uses three (3) parameters to specify the total system RAM (8 GB)
along with a region/subregion.
Expand Down