0 Fork 0

mirror of https://github.com/opensourcepos/opensourcepos.git synced 2026-10-28 19:18:58 -04:00

Files

T

jekkos f37021a860 docs: move BUILD.md, INSTALL.md, UPGRADE.md into docs/ (#4755 )

* docs: move BUILD.md, INSTALL.md, UPGRADE.md into docs/

Closes #4751

- Move the three detailed guides from the repo root into docs/
- Update all links in README.md, .github/ISSUE_TEMPLATE.md,
  docker-compose.yml, and cross-references within the moved guides
- Add docs/**/* to the gulp compress task so release archives
  include the guides under their new docs/ path
- README now links to all three guides
- Root-level files (README, CHANGELOG, LICENSE, SECURITY.md,
  CODE_OF_CONDUCT.md, AGENTS.md) remain in place

* docs: add working-dir note and remove stale 'docs' .gitignore entry

- Add explicit note that Docker/install commands run from repo root
- Remove stale 'docs' line from .gitignore (leftover from old ApiGen
  output) so tracked files under docs/ can be modified normally

2026-10-16 09:20:45 +02:00

4.6 KiB

Raw Blame History

How to Upgrade

Note

This guide covers upgrading an existing installation of OSPOS 3.x (for example 3.4.1 → 3.4.2, or any 3.4.x → a newer 3.4.x). Installing OSPOS for the first time is different — see INSTALL.md.

What is in the code, and what is not

Upgrading replaces the application code with the new release. Your data and settings are not stored in the code. They live in:

Your database — all of your business data (products, customers, sales, employees, settings, …).
Your .env file (project root) — database credentials, encryption.key, throttle.key, app.allowedHostnames, and other configuration.
Your public/uploads/ folder — uploaded product images and other files.
Any custom app/Config/*.php edits — only if you personally changed a config file.

Because of this, an upgrade is simply: back up → replace the code → restore your files → log in (the database schema updates itself automatically — see below). You do not need to run any SQL upgrade scripts by hand.

What to back up before you start

Your database — a full dump (for example mysqldump) is the most important thing; it is the only place your data lives.
Your .env file (project root) — it holds your database password and your encryption.key. Losing encryption.key makes previously encrypted data unrecoverable.
Your public/uploads/ folder.
Your current code directory — a full copy, so you can roll back.

How to upgrade

Back up your database, your .env file, and your current code directory.
Download the new release (e.g. 3.4.2) from the Releases page and unzip it.
Replace the application code with the files from the new release. (You can overwrite your existing install in place — see the next section.)
Restore your user-specific files on top of the new code:
- Put your original .env back in the project root.
- Put your original public/uploads/ folder back in place.
- Re-apply any custom app/Config/*.php edits you made.
Log in. The first login takes a little longer: OSPOS runs its database migrations automatically to bring your schema up to the new version.
That's it. Your data, settings, and uploads are intact and the app is on the new version.

Can I just overwrite the new files on top of the old install?

Yes — uploading the new release on top of your existing install is fine, as long as you protect your user-specific files first. Two things to watch:

Warning

Releases ship with a fresh, default .env file (generated from .env.example, pointing at localhost with the default ospos credentials). If you let the new release's .env replace yours, you lose your database password and encryption.key. Copy your current .env out of the way before overwriting, and copy it back afterwards. If you do end up starting from the new .env, copy your old database.* and encryption.key values into it.

Warning

Do not delete your database or public/uploads/ folder during an upgrade — they are separate from the code and hold everything you care about.

Version-specific notes

Check the CHANGELOG for your target version for the full list of changes. A few things that can require action when upgrading:

3.4.2 and later (production)

app.allowedHostnames is required in production. If it is not set, the application fails to start (host-header-injection protection). Add it to your .env (or set the ALLOWED_HOSTNAMES environment variable), e.g.:
```
app.allowedHostnames='yourdomain.com,www.yourdomain.com'
```

Rolling back

To roll back, restore your backed-up code directory. Because the upgrade applies database migrations on first login, check whether the older release works with the current schema — if it does not, restore your pre-upgrade database dump along with the old code. Your .env is independent of the code and does not need to change.

Still having trouble?

Read the README and the GitHub issues — a similar issue may already be reported and answered.
Open a new issue with your OSPOS version, the version you upgraded from, and the exact error you see. If the page is blank, check your web server and PHP error logs (you can temporarily raise logger.threshold in your .env to capture more detail) and include the relevant lines. Avoid enabling display_errors on a public production site, as it can expose internal details.

4.6 KiB Raw Blame History