Skip to content

docs: Explicit restrictions of atlantis user apply to the --data-dir flag #2908

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

Closed
wants to merge 4 commits into from
Closed

docs: Explicit restrictions of atlantis user apply to the --data-dir flag #2908

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
96ec442
Change the directory mentioned in the `--data-dir` flag description
bschaatsbergen Jan 2, 2023
3b563b2
Be more explicit on how restrictions of the atlantis user may apply t…
bschaatsbergen Jan 2, 2023
05fd09b
wrap flag in quotes
bschaatsbergen Jan 2, 2023
1b24c11
`Please note` -> `Note`
bschaatsbergen Jan 2, 2023
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
5 changes: 4 additions & 1 deletion runatlantis.io/docs/server-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,13 @@ Values are chosen in this order:
atlantis server --data-dir="path/to/data/dir"
```
Directory where Atlantis will store its data. Will be created if it doesn't exist.
Defaults to `~/.atlantis`. Atlantis will store its database, checked out repos, Terraform plans and downloaded
Defaults to `/home/atlantis/`. Atlantis will store its database, checked out repos, Terraform plans and downloaded
Terraform binaries here. If Atlantis loses this directory, [locks](locking.html)
will be lost and unapplied plans will be lost.

Note that the atlantis user is restricted to `/home/atlantis/`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd mention the gosu portion in the atlantis-base image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it not rather confusing to document this under the --data-dir flag?

If you set the `--data-dir` flag to a path outside of Atlantis its home directory, ensure that you grant the atlantis user the correct permissions.

### `--default-tf-version`
```bash
atlantis server --default-tf-version="v0.12.0"
Expand Down