Skip to content

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

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

Merged
merged 6 commits into from
Jan 4, 2023
Merged

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

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6b98e0a
Change the directory mentioned in the `--data-dir` flag description
bschaatsbergen Jan 2, 2023
9a6d31b
Be more explicit on how restrictions of the atlantis user may apply t…
bschaatsbergen Jan 2, 2023
4f338f3
wrap flag in quotes
bschaatsbergen Jan 2, 2023
e06e52d
`Please note` -> `Note`
bschaatsbergen Jan 2, 2023
12984a7
revert back to `~/atlantis`
bschaatsbergen Jan 4, 2023
ba983ce
Update server-configuration.md
bschaatsbergen Jan 4, 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 @@ -317,10 +317,13 @@ and set `--autoplan-modules` to `false`.
ATLANTIS_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/`.
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.31"
Expand Down